SamplingConfiguration Class Reference

Inheritance diagram for SamplingConfiguration:

Public Member Functions
	SamplingConfiguration (int yamlConfigVersion)
void	configure (const Properties *properties) override
	Configure this object instance by de-serializing the given Properties.
Properties	toSplitImagesAlgorithmProperties () const
const std::string &	logDomain () const
Public Member Functions inherited from Configurable
virtual void	configuration (Properties *p) const
	Serialize the current object configuration into the given Properties object.
virtual void	configureDefaults ()
	Retrieve the properties of this object, replaces values with their defaults and sets it again.
void	registerParameter (ParameterBase *param)
	Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void	unregisterParameter (const ParameterBase *param)
	Remove the given Parameter or SubProperty from the list of registered parameters.
	Configurable (const Configurable &rhs)
	Configurable (Configurable &&rhs) noexcept
Configurable &	operator= (const Configurable &)
Configurable &	operator= (Configurable &&) noexcept

Public Attributes
SamplingParameter< vec3i >	p_maxSizeSubDivisions = {"MaxSizeSubdivision", vec3i(-1, -1, -1), this, ParamRequired::No, "maxSize"}
	Maximum dimensions of the extracted patches.
SamplingParameter< int >	p_pixelsOverlap = {"PixelsOverlap", 0, this, ParamRequired::No, "overlap"}
	Minimal pixel overlap of the extracted patches, the exact overlap is automatically deduced.
SamplingParameter< vec3i >	p_subImagesDimDivisor = {"DimensionDivisor", vec3i::Ones(), this, ParamRequired::No, "dimensionDivisor"}
	Each dimension in an extracted patch is guaranteed to be a multiple of the corresponding dimensionDivisor.
SamplingParameter< bool >	p_weighted = {"RecombineWeighted", false, this, ParamRequired::No, "weighted"}
	Turn On/Off Gaussian weighted recombination of images.
SamplingParameter< std::string >	p_recombineDevice = {"RecombineDevice", "CPU", this, ParamRequired::No, "recombineDevice"}
	Specify the device for computing the recombination of images.
SamplingParameter< PaddingMode >	p_paddingMode = {"PaddingMode", PaddingMode::Mirror, this, ParamRequired::No, "paddingMode"}
	Set padding mode used for the input image.
SamplingParameter< bool >	p_extendImage = {"ExtendImage", false, this, ParamRequired::No, "extendImage"}
	Pad the image with twice the overlap amount.
SamplingParameter< bool >	p_skipUnpadding
	Whether to skip unpadding of the image.
SamplingParameter< bool >	p_ensureInputImageMultipleOfDivisor
	Pad the input image such that the dimensions are a multiple of the DimensionDivisor.
Public Attributes inherited from Configurable
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members
Protected Attributes inherited from Configurable
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

configure()

void configure ( const Properties * p )

overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also

configuration() for the inverse functionality

Reimplemented from Configurable.

Member Data Documentation

p_skipUnpadding

SamplingParameter<bool> p_skipUnpadding

Whether to skip unpadding of the image.

Since the default value depends on the ModelConfiguration::VERSION_COUNT, the value is created dynamically at construction

p_ensureInputImageMultipleOfDivisor

SamplingParameter<bool> p_ensureInputImageMultipleOfDivisor

Initial value:

= {"EnsureInputImageMultipleOfDivisor",
                                                                           false,
                                                                           this,
                                                                           ParamRequired::No,
                                                                           "ensureInputImageMultipleOfDivisor"}

Pad the input image such that the dimensions are a multiple of the DimensionDivisor.

Used for legacy models

---

The documentation for this class was generated from the following file:

• ImFusion/ML/ModelConfiguration.h