Package boofcv.struct

Interface Configuration

All Superinterfaces:
Serializable
All Known Subinterfaces:
ConfigDisparityError, ConfigOrientation, ConfigOrientation.Gradient, ConfigOrientation.Integral
All Known Implementing Classes:
BaseConfigBackground, BaseConfigPolyline, ConfigAssociate, ConfigAssociateGreedy, ConfigAssociateNearestNeighbor, ConfigAverageIntegral, ConfigBackgroundBasic, ConfigBackgroundGaussian, ConfigBackgroundGmm, ConfigBrief, ConfigBroxWarping, ConfigBundleUtils, ConfigCalibrationTarget, ConfigChessboardBinary, ConfigChessboardX, ConfigCircleHexagonalGrid, ConfigCircleRegularGrid, ConfigCirculantTracker, ConfigComaniciu2003, ConfigCompleteSift, ConfigConverge, ConfigConvertTupleDesc, ConfigDeformPointMLS, ConfigDenseHoG, ConfigDenseSift, ConfigDenseSurfFast, ConfigDenseSurfStable, ConfigDescribePoint, ConfigDescribeRegion, ConfigDetectDescribe, ConfigDetectInterestPoint, ConfigDiscreteLevels, ConfigDisparity, ConfigDisparityBM, ConfigDisparityBMBest5, ConfigDisparityError.Census, ConfigDisparityError.HMI, ConfigDisparityError.NCC, ConfigDisparitySGM, ConfigDisparitySGM.ConfigBlockMatchError, ConfigECoCheckDetector, ConfigECoCheckMarkers, ConfigECoCheckMarkers.MarkerShape, ConfigEdgeThreshold, ConfigEllipseDetector, ConfigEllipseEdgeCheck, ConfigEpipolarScore3D, ConfigEpipolarScore3D.FundamentalCompatible, ConfigEpipolarScore3D.FundamentalRotation, ConfigEpipolarScore3D.ModelInliers, ConfigEssential, ConfigExtract, ConfigFastCorner, ConfigFastHessian, ConfigFeatureToSceneRecognition, ConfigFh04, ConfigFiducialBinary, ConfigFiducialHammingDetector, ConfigFiducialImage, ConfigFundamental, ConfigGeneralDetector, ConfigGeneratePairwiseImageGraph, ConfigGenerateStereoGraph, ConfigGridDimen, ConfigGridUniform, ConfigHammingChessboard, ConfigHammingGrid, ConfigHammingMarker, ConfigHarrisCorner, ConfigHierarchicalVocabularyTree, ConfigHomography, ConfigHornSchunck, ConfigHornSchunckPyramid, ConfigHoughBinary, ConfigHoughFootSubimage, ConfigHoughGradient, ConfigKeyFrameManager, ConfigKlt, ConfigLength, ConfigLineRansac, ConfigLlah, ConfigLMedS, ConfigMeanShiftSearch, ConfigMicroQrCode, ConfigMultiviewStereo, ConfigOpticalFlowBlockPyramid, ConfigOrientation2, ConfigParamFoot, ConfigParamPolar, ConfigPixelsToMetric, ConfigPKlt, ConfigPlanarTrackPnP, ConfigPnP, ConfigPointDetector, ConfigPointTracker, ConfigPolygonDetector, ConfigPolygonFromContour, ConfigPolylineSplitMerge, ConfigProjectiveReconstruction, ConfigQrCode, ConfigRansac, ConfigRecognitionNearestNeighbor, ConfigRecognitionNister2006, ConfigRefinePolygonLineToImage, ConfigRgbDepthTrackPnP, ConfigSegmentMeanShift, ConfigSelectFrames3D, ConfigSelectLimit, ConfigSelfCalibDualQuadratic, ConfigSelfCalibEssentialGuess, ConfigSelfCalibPracticalGuess, ConfigSfot, ConfigShiTomasi, ConfigSiftDescribe, ConfigSiftDetector, ConfigSiftOrientation, ConfigSiftScaleSpace, ConfigSimilarImagesSceneRecognition, ConfigSimilarImagesTrackThenMatch, ConfigSlic, ConfigSlidingIntegral, ConfigSparseToDenseCloud, ConfigSpeckleFilter, ConfigSplitMergeLineFit, ConfigSquareGrid, ConfigStereoDualTrackPnP, ConfigStereoMonoTrackPnP, ConfigStereoQuadPnP, ConfigSurfDescribe, ConfigSurfDescribe.Fast, ConfigSurfDescribe.Stability, ConfigTemplateDescribe, ConfigThreeViewRefine, ConfigThreshold, ConfigThresholdBlockMinMax, ConfigThresholdLocalOtsu, ConfigTld, ConfigTrackerDda, ConfigTrackerHybrid, ConfigTrackerTld, ConfigTriangulation, ConfigTrifocal, ConfigTrifocalError, ConfigUchiyaMarker, ConfigVisOdomTrackPnP, ConfigWatershed, GridShape

public interface Configuration
extends Serializable
Complex algorithms with several parameters can specify their parameters using a separate class. This interface is intended to provide a common interface for all such configuration classes.
  • Method Summary

    Modifier and Type Method Description
    void checkValidity()
    Checks to see if the configuration is valid.
    default List<String> serializeActiveFields()
    Optional functions that tells a serializer which fields are being used and not ignored.
    default void serializeInitialize()
    Optional function which is called after deserialization and performs initialization
  • Method Details

    • checkValidity

      void checkValidity()
      Checks to see if the configuration is valid. If it is invalid, throw an exception explaining what is incorrect.
    • serializeInitialize

      default void serializeInitialize()
      Optional function which is called after deserialization and performs initialization
    • serializeActiveFields

      default List<String> serializeActiveFields()
      Optional functions that tells a serializer which fields are being used and not ignored. a field is ignored when there a "type" and only members of the type are used. If empty then it's assumed all fields are active.