#include <ImFusion/Core/Configurable.h>

Base interface for classes that support object serialization from/to Properties objects. More...

Inherited by ConfigurableSequence< ImFusion::Dicom::SegmentItem >, ASCRegistrationMethod, ModifyBehavior::PerStructureBoolean, ActiveEnvironmentControl, Algorithm, AnatomicalStructure, AnatomicalStructureRegistration, AnatomicalStructuresCollider, StyleSheet, StyleSheet::StyleRule, AnnotationModel, BackgroundExporter, CSVParser, ConeBeamGeometry, EventHandler, FullGeometryRepresentationWrapper, Functional, GeometryGenerator, LinearOperator, OptimizationProblem, ProjectionPreProcessing, RelativeTransformationConfig, Solver, XRay2D3DRegistrationHistoryEntry, XRay2D3DRegistrationInitialization, TrivialConfigurable, Camera, CameraCalibrationSettings, CliqueLookupTable [private], ColorMapOptimization, CombinedTrackingStream::CombinationInstruction, Controller, ControllerDecorator, CurvedViewPrimitive, DataComponentBase, DataComponentList, DataMatrixTransformer, DataSourceComponent::DataSourceInfo, DatasetLicenseComponent::DatasetInfo, DeformableIcp, DeformableIcp::RansacProperties, Deformation, DependentKeypoint, DescriptorsRegistrationAlgorithm::GlobalRegistrationConfig, ClinicalTrialSubjectDataComponent::OtherProtocolID, ConfigurableSequence< T >, ConfigurableSequenceItem, DatasetHandler, DicomParameterHelper [private], IOD_Registry, DicomPluginSettings, DicomWriter, DisplayWidget, ElementwiseDataComponentList, EndoscopicToolSegmentation, FakeTrackingStream::Device, FeatureDetector, FeatureMatchPruner, FeatureMatcher, FeatureSampler, DisplayAutoLayouter, InputEventMapperBase, RadiologyDisplay, View, ViewOverlay, GlGraph::DisplayOptions::FeatureCircleOptions, GlGraph::DisplayOptions::FeatureColorMapOptions, GlGraph::DisplayOptions::GeneralOptions, GlMeshRendererContours::DisplayOptions, GlMeshRendererIntersection::DisplayOptions, GlMeshRendererNormals::DisplayOptions, GlMeshRendererSurface::DisplayOptions, GlMeshRendererSurface::DisplayOptions::Clipping, GlMeshRendererSurface::DisplayOptions::Material, GlObject, GlScreenSpaceAmbientOcclusion, GlSliceRenderer, GlVolumeRenderer, Image, LabelOverlapEncoder, LiveTrackingPointRegistrationAlgorithm::Correspondence, DataLoader, Engine, EngineConfiguration, Metric, ModelConfiguration, NetworkTrainingFileGenerator, SamplingConfiguration, MVSTexturing, MarkerConfiguration, Mask, MonocularDepthEstimation, MotionModel, Node, OpticalFlow, Optimizer, PointsOnData, PropertiesListWidget, PropertiesWidget, PythonSettings, RGBDStream::FrameInfo, FrameTransform, ROSBagImportSpecification, ROSBagImportSpecification::ImageImportOptions, ROSBagImportSpecification::PlaybackOptions, ROSBagImportSpecification::TrackingImportOptions, ROSBagSelection, ROSBagTfSelection, ROSPluginSettings, Regression, RobotGUIProperties, RobotInstance, RobotLocation, RobotRunner, RoboticsPluginSettings, TorqueControllerParametersInterface, Contour, Selection, Settings, SettingsDialog::CustomSettingsWidget, SimilarityMeasureFactory, SimilarityMeasureImpl, SpineLocalization2DAlgorithm::ModelSet, StereoReconstruction, Stream, StreamSettings, SurfaceReconstructionData, TransferFunction, Tree, FrameGeometry [protected], FrameGrabbingPresets, GeometryDetection, MotionTrajectoryModel, ProbeTrackerPair, ProcessUltrasound, SweepCalibrationData, SweepCalibrator, USPluginSettings, UltrasoundRegistrationAlgorithm::AdvancedConfig, UltrasoundRegistrationAlgorithm::LandmarkWeightingConfig, UltrasoundRegistrationAlgorithm::SegmentationWeightingConfig, VectorFieldFlow, ViewGroup, , and VisionMLModelsFactory.

Detailed Description

Base interface for classes that support object serialization from/to Properties objects.

Implementing this interface enables you to make custom data structure serializable by implementing the pair of configuration() (store) and configure() (retrieve) methods in a symmetric fashion. For instance:

class MyClass : public Configurable {
public:
    void configuration(Properties* p) const override {
        if (!p)
            return;
 
        Configurable::configuration(p);
        p->setParam("intValue", m_intValue, 42);
        p->setParam("stringValue", m_stringValue);
    }
 
    void configure(const Properties* p) override {
        if (!p)
            return;
 
        Configurable::configure(p);
        p->param("intValue", m_intValue);
        p->param("stringValue", m_stringValue);
    }
 
private:
    int m_intValue = 42;
    std::string m_stringValue;
};

Since manually implementing the serialization code can be cumbersome and error-prone you can make use of the Parameter and SubProperty interfaces: after registering them with the Configurable interface their default implementation of configuration() and configure() will automatically (de-)serialize their values into/from the Properties. You can even consider making the Parameter members public to avoid writing getters/setters for them. By convention, Parameter-members use the p_ prefix instead of the m_ prefix to make their semantics easier to identify in calling code.

class MyClass : public Configurable {
public:
    // Passing `this` to the ctor will automatically register the Parameter with the parent Configurable.
    // Otherwise, you must call registerParameter() manually.
    Parameter<int> p_intValue = {"intValue", 42, this};
    Parameter<std::string> p_stringValue = {"stringValue", "", this};
};

Note: Be aware of the implications of the parent-child relationship between a Configurable and its nested Parameters/SubProperties when it comes to copying/moving instances: Copying/moving a Configurable instance must make sure that its nested Parameters/SubProperties are correctly registered with the new instance in order to ensure that they partake in the serialization process and the signalParametersChanged is emitted correctly. This is ensured by the default implementations of the Configurable copy and move constructor. Make sure to also do so when implementing custom copy/move constructors in derived classes.

See also: Object Serialization, Properties, Parameter, SubProperty

Examples: Serialization.cpp.

Classes
struct	Param

Public Member Functions
virtual void	configure (const Properties *p)
	Configure this object instance by de-serializing the given Properties.

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
Signal	signalParametersChanged
	Emitted whenever one of the registered Parameters' or SubPropertys' `signalValueChanged` signal was emitted.

Protected Attributes
std::vector< Param >	m_params
	List of all registered Parameter and SubProperty instances.

Member Function Documentation

◆ configure()

virtual void configure ( const Properties * p )

virtual

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 in AbstractImageRegistration, ActiveEnvironmentControl, AnalyzeMotion, AnatomicalStructure, AnatomyAlgorithm, AnatomyDataComponent, InspectStyleSheetsAlgorithm, StyleSheet, StyleSheet::StyleRule, AnnotationModel, ApplyMaskAlgorithm, ASCDisplayOptions, ASCIoAlgorithm, PerAnatomy< IndividualRegistrationMethod >, PerAnatomy< ASImageBasedRefine >, AttachTrackingSequenceAlgorithm, AverageImagesAlgorithm, BackgroundExporter, BakeDeformationAlgorithm, BakeMeshDeformationAlgorithm, BakeTransformationAlgorithm, BasicImageProcessing, BasicProcessingStream, BicubicBSplineApproximationAlgorithm, BilateralFilterAlgorithm, BinaryMaskToTextAlgorithm, BullseyeVisualizationAlgorithm, Camera, CameraCalibrationAlgorithm, CameraCalibrationDataComponent, CameraCalibrationSettings, CameraRegistrationAlgorithm, ClFftAlgorithm, ColorMapOptimization, CombinedTrackingStream, CombineImagesAlgorithm, CombineImagesAsVolumeAlgorithm, CombineMeshesAlgorithm, CombinePointCloudsAlgorithm, ConnectedComponentsAlgorithm, ContrastFilter, CreateStreamAlgorithm< T, autoOpenDefaultValue, autoConnectDefaultValue, takesArguments >, CreateStreamIoAlgorithm< T, autoOpenDefaultValue, autoConnectDefaultValue >, CropLabelMapAlgorithm, CroppingMask, CSVParser, AutoFocusMotionCompensationAlgorithm, BeamHardeningCompensation, CBCTPostProcessing, ConeBeamCalibration, ConeBeamGeometry, ConeBeamMetadata, ConeBeamReconLoader, ConeBeamReconLoaderExtra, ConeBeamSimulation, ConvertToConeBeamData, PerFrameTransformationGeneratorBase, RelativeTransformationSetupWrapperBase, TrivialConfigurable, FDK, Functional, GeometryAlgorithm, GeometrySelfCalibration, Gl2D3DRegistration, GlFourierFilter1D, LinearOperatorAdjointWrapper, MotionModelGenerator, OptimizationProblem, ProjectionPreProcessing, ProjectionPreProcessingAlgorithm, ReconstructionAlgorithm, RelativeTransformationConfig, SnapshotGenerator, Solver, XRay2D3DRegistrationAlgorithm, XRay2D3DRegistrationHistoryEntry, XRay2D3DRegistrationInitializationKeyPoints, CurvedView, CurvedViewPrimitive, CurvedViewSettingsController, DataComponentList, DataMatrixTransformer, DatasetLicenseComponent, DataSourceComponent, DataSourceComponent::DataSourceInfo, DefaultControllerDecorator, DeformableIcpAlgorithm, DeformationEditor, DemonsImageRegistration, DependentKeypoint, DepthMapToPointCloudAlgorithm, DescriptorsRegistrationAlgorithm, ClinicalTrialSubjectDataComponent, ConfigurableSequence< T >, ConfigurableSequence< ImFusion::Dicom::SegmentItem >, GeneralEquipmentModuleDataComponent, IOD_Registry, ReferencedInstancesComponent, RTStructureDataComponent, SegmentItem, SourceInfoComponent, DicomIoAlgorithm, DicomIOAlgorithmBrowser, DicomIOAlgorithmFolder, DicomPluginSettings, DicomWriter, DisplacementVisualizer, DisplayOptions2d, DisplayOptions3d, DisplayWidget, DisplayWidgetMulti, DoseComputationAlgorithm, ElementwiseDataComponentList, EndoscopicToolSegmentationAlgorithm, EndoscopicToolSegmentationCustomModel, ExplicitIntensityMask, ExplicitMask, ExtractSelection, ExtractTrackingSequence, FakeImageStream, FakePolyDataStream, FakeTrackingStream, FakeTrackingStream::ConstantDevice, FakeTrackingStream::OscillatingDevice, FakeTrackingStream::SweepDevice, FeatureDetectionAlgorithm, FeatureDetectorWithAdaptiveThreshold, FFDImageRegistration, FiducialExtractionAlgorithm, FitBoundingBoxAlgorithm, FlowVisualizationAlgorithm, FreeFormDeformation, FreeFormMeshAlgorithm, FrequencyFilterAlgorithm, GatingMetadata, GlAnnotation, GlArrow, GlAxis, GlBox, GlCircle, GlCrosshair, GlCurve, GlCurvedViewCircle, GlCurvedViewEllipse, GlCurvedViewPolyLine, GlCurvedViewSpline, GlCutLine, GlDenseDeformation, GlEllipse, GlFilterSet, GlGrid, GlIcon, GlInfiniteLine, GlLine, GlLoop, GlMesh, GlObject, GlParallelogram, GlPlane, GlPointBasedAnnotation, GlPointCloud, GlPolyRigidDeformation, GlRectangleBillboard, GlScreenSpaceAmbientOcclusion, GlSliceRendererImage, GlSpline, GlTPSDeformation, GlTransformerObject, GlVolumeCompounding, GlVolumeRenderer, GlVolumeRendererBasic, GlVolumeRendererGlobalIllum, GraphBasedSegmentation, GraphLaplacianAlgorithm, DisplayAutoLayouter, InputEventMapperBase, RadiologyDisplay, ViewOverlay, HDF5IoAlgorithm, HoughTransformAlgorithm, ConnectionIoAlgorithm, CreateDeviceAlgorithm, Image, ImageBasedGatingAlgorithm, ImageInfoDataComponent, ImageMattingAlgorithm, ImageRegistration, ImageResamplingAlgorithm, ImageSequenceRegistration, ImageSetAutoCorrelation, ImageSetIoAlgorithm, ImageSharpnessEstimationAlgorithm, ImageStatisticsAlgorithm, ImageTemplateDataComponent, ImageTemplateMatchingAlgorithm, ImageView2D, ImageView3D, ImFusionFileIoAlgorithm, IMURawMetadata, InstrumentCalibrationDataComponent, IntensityClusteringAlgorithm, IntensityMask, InteractiveSegmentationController, IntraOralFilter, InvertDeformationAlgorithm, IoAlgorithm, IoController, KinectAzureStream, LabelDataComponent, LabelMapPropagationAlgorithm, LabelOverlapEncoder, LabelsOperationsAlgorithm, LabelStatisticsAlgorithm, LabelsToNarrowBandAlgorithm, LiveImageBasedGatingTestAlgorithm, LiveStereoCalibrationAlgorithm, LiveStreamingAlgorithm, LiveTrackingAlgorithm, LiveTrackingPointRegistrationAlgorithm, LogisticRegression, MarkAsLabelMapAlgorithm, MarkerConfiguration, MarkerDetectionAlgorithm, MarkerHandEyeCalibrationAlgorithm, MaskEditor, Measuring, MeshAlignmentAlgorithm, MeshBooleanOperationsAlgorithm, MeshDistanceAlgorithm, MeshIoAlgorithm, MeshOctreeNode, MeshPointCloudCroppingAlgorithm, MeshPointCloudCroppingController, MeshProcessingAlgorithm, MeshToLabelMapAlgorithm, MetaImageIoAlgorithm, MirrorRegistrationAlgorithm, AddPositionAsChannelAlgorithm, BatchDataLoader, DataListReader, DataLoader, Engine, EngineConfiguration, FileReader, FilterDataLoader, FilterEmptyElementContentDataLoader, GenerateBoxSegmentationTrainingDataAlgorithm, InterleaveDataLoader, InversionComponent, LandmarkPredictionAlgorithm, LocalConvolutionalNetworkAlgorithm, MachineLearningModelAlgorithm, MapDataLoader, MetricAlgorithm, ModelConfiguration, MRIBiasFieldCorrectionAlgorithm, NetworkTrainingFileGenerator, OperationsSequenceAlgorithm, PaddingDoneDataComponent, PatchesFromImageDataComponent, PreprocessDataLoader, ProcessingRecordComponent, ReferenceImageDataComponent, RepeatDataLoader, SampleDataLoader, SamplingConfiguration, ShuffleDataLoader, TargetTag, MonocularDepthEstimationAlgorithm, MultiLogisticRegression, MVSTexturing, NDITrackingStream, ConnectionLatencyMeasuringAlgorithm, NiftiIoAlgorithm, NrrdIoAlgorithm, OctreeDataComponent, OpenNI2RGBDStream, OpticalFlowAlgorithm, OpticalFlowRAFT, OpticalFlowSEARAFT, Optimizer, OptimizerDiRect, OptimizerNelderMead, OptimizerNL, OptimizerSeries, OptimizerXNES, OptimizingAlgorithm, ParametricDeformableRegistration, ParametricImageRegistration, PlaybackAlgorithm, PlaybackStereoImageStreamAlgorithm, PlottingAlgorithm, PointCloudAnalysis, PointCloudFilteringAlgorithm, PointCloudIoAlgorithm, PointCloudMeasuringAlgorithm, PointCloudOverlapAlgorithm, PointCloudPlaneFittingAlgorithm, PointCloudToDepthMapAlgorithm, PointCorrAlgorithm, PointCorrespondencesAlgorithm, PointNode, PointsOnData, PointsOnTrackingStream, PointsStorageComponent, PoissonSurfaceReconstructionAlgorithm, PolarisAuroraTrackingStream< NDIType >, PolyRigidDeformationAlgorithm, PolyRigidImageRegistration, PoseGraphOptimizationAlgorithm, PropertiesListWidget, PropertiesWidget, RawImageIoAlgorithm, RealSenseStream, RealWorldMappingDataComponent, RegistrationFromPredictionMapAlgorithm, RegistrationInitAlgorithm, RegistrationResultsAlgorithm, Regression, RemoteVideoStream, ReplaceValuesAlgorithm, RGBDCalibrationAlgorithm, RGBDDataComponent, RGBDIoAlgorithm, RGBDPlaybackExtractionAlgorithm, RGBDReconstructionAlgorithm, RGBDStream::FrameInfo, RGBDTumSequenceIoAlgorithm, RIDEFeatureDetector, CreateRobotStreamAlgorithm, FakeRobotControlStream, HighResTimestampDataComponent, JointTrajectoryDataComponent, KeyboardTrackingStream, RobotInstance, RobotRunner, RobotStateStream, RollingGuidanceFilterAlgorithm, CreateROSStreamAlgorithm, ROSBagImportSpecification, ROSBagImportSpecification::ImageImportOptions, ROSBagImportSpecification::TrackingImportOptions, ROSBagIoAlgorithm, ROSBagSelection, ROSBagTfSelection, ROSPluginSettings, ROSTfTrackingStream, Contour, ContoursStorageComponent, StructuresViewAlgorithm, StructuresViewAlgorithmController, Selection, SetModalityAlgorithm, SetSpacingAlgorithm, Settings, SharedImageArithmeticAlgorithm, SimilarityMeasureFactory, SimilarityMeasureImpl, SimilarityMeasureImplHistBased, SimilarityMeasureImplPixelWise, SimilarityMeasureLC2, SimilarityMeasureLNCC, SimilarityMeasureMI, SimilarityMeasureML, SimilarityMeasureSSIM, SimilarityMeasureTester, SimilarityMeasureWrapper, SkippingMask, SmoothedTrackingStream, SpineLocalization2DAlgorithm, SplineSlicingAlgorithm, SplitChannelsAlgorithm, SplitImagesAlgorithm, StereoCGIReconstruction, StereoReconstructionAlgorithm, StereoReconstructionRAFT, StereoStreamReconstructionAlgorithm, StreamAlgorithmExecutor, StreamRecorderAlgorithm, SuperpixelsAlgorithm, SuperpixelsFilter, SurfaceReconstructionData, SurfaceRegistration, SyntheticDataAlgorithm, TemporaryDataComponent, TensorFrequencyFilteringAlgorithm, TensorLocalAverageAlgorithm, TexturingAlgorithm, TimestampDataComponent, ToolCalibrationAlgorithm, ToolVisualizationAlgorithm, TrackedSharedImageSetPropertiesAlgorithm, TrackingInstrumentFiducialsData, TrackingInstrumentRawData< T >, TrackingSequenceIO, TrackingSequenceProcessing, TrackingStreamDisplayOptions, TrackingStreamPropertiesAlgorithm, TrackingStreamVisualizationAlgorithm, TransferFunction, TransformationStashDataComponent, Tree, BoneSegmentationAlgorithm, BoneSegmentationBaseAlgorithm, ComposedMotionModel, ConvertToSweep, ExtractDoppler, FanMask, FrameGeometry, FrameGeometryCircular, FrameGeometryConvex, FrameGeometryConvexSteered, FrameGeometryLinear, FrameGeometryMetadata, FrameGeometryPropertiesAlgorithm, FrameGeometrySector, FrameGrabbingConfigComponent, FrameGrabbingPresets, GatingMotionModel, GenerateDataForTrackingEstimation, GeometryDetectionAlgorithm, GlProbeDeformation, GlSliceRendererSweep, GlSweepCompounding, GlSweepStretchDeformation, ImportCalibrationAlgorithm, KeyframeMotionModel, LiveGeometryDetectionAlgorithm, LiveSweepRecordingVisualizationAlgorithm, MotionTrajectoryModel, NeedleSweepCalibrationAlgorithm, ParametricMotionModel, ProbeTrackerPair, ProcessedUltrasoundStream, ProcessUltrasound, ProcessUltrasoundClip, RawDataComponent, ScanConversion3D, ScanConversion, SimpleMotionModel, SliceToVolumeRegistrationAlgorithm, SweepCalibrationData, SweepCalibrator, SweepCroppingAlgorithm, SweepGlobalInitAlgorithm, SweepMotion, SweepPointCorrAlgorithm, SweepPropertiesAlgorithm, SweepRecorderAlgorithm, SweepRecorderController, SyntheticUltrasoundSweepAlgorithm, TrackingEstimationController, UltrasoundCalibration, UltrasoundMetadata, UltrasoundRegistrationAlgorithm, UltrasoundSimulation, UltrasoundSimulationHybrid, VolumeReslicingAlgorithm, VectorDataComponent, VideoIoAlgorithm, VideoStreamIoAlgorithm, ViewGroup, OpticalFlowAlgorithm, VitalsDataComponent, VolumeBasedMeshRegistrationAlgorithm, WatershedSegmentationAlgorithm, and ZipIoAlgorithm.

◆ configuration()

virtual void configuration ( Properties * p ) const

virtual

Serialize the current object configuration into the given Properties object.

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

See also: configure() for the inverse functionality

◆ configureDefaults()

virtual void configureDefaults ( )

virtual

Retrieve the properties of this object, replaces values with their defaults and sets it again.

Reimplemented in ConfigurableSequence< T >, ConfigurableSequence< ImFusion::Dicom::SegmentItem >, MachineLearningModelAlgorithm, and OperationsSequenceAlgorithm.

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

ImFusion/Core/Configurable.h

Detailed Description

Classes

Public Member Functions

Public Attributes

Protected Attributes

Member Function Documentation

◆ configure()

◆ configuration()

◆ configureDefaults()