OpenCMISS-Zinc C++ API Documentation
 All Classes Namespaces Files Functions Typedefs Enumerations Enumerator Pages
Public Member Functions | List of all members
OpenCMISS::Zinc::FieldImagefilterHistogram Class Reference

Image processing derived field type performing the ITK histogram field. More...

#include <fieldimageprocessing.hpp>

Inheritance diagram for OpenCMISS::Zinc::FieldImagefilterHistogram:
OpenCMISS::Zinc::Field

Public Member Functions

 FieldImagefilterHistogram (cmzn_field_imagefilter_histogram_id field_imagefilter_histogram_id)
 
int getComputeMinimumValues (int valuesCount, double *valuesOut)
 
int setComputeMinimumValues (int valuesCount, const double *valuesIn)
 
int getComputeMaximumValues (int valuesCount, double *valuesOut)
 
int setComputeMaximumValues (int valuesCount, const double *valuesIn)
 
int getNumberOfBins (int valuesCount, int *valuesOut)
 
int setNumberOfBins (int valuesCount, const int *valuesIn)
 
double getMarginalScale ()
 
int setMarginalScale (double marginalScale)
 
- Public Member Functions inherited from OpenCMISS::Zinc::Field
 Field (cmzn_field_id field_id)
 
 Field (const Field &field)
 
Fieldoperator= (const Field &field)
 
bool isValid () const
 
cmzn_field_id getId () const
 
bool isManaged ()
 
int setManaged (bool value)
 
char * getComponentName (int componentNumber)
 
int setComponentName (int componentNumber, const char *name)
 
double getCoordinateSystemFocus ()
 
int setCoordinateSystemFocus (double focus)
 
CoordinateSystemType getCoordinateSystemType ()
 
int setCoordinateSystemType (CoordinateSystemType coordinateSystemType)
 
int getNumberOfComponents ()
 
char * getName ()
 
int setName (const char *name)
 
int getNumberOfSourceFields ()
 
Field getSourceField (int index)
 
bool isTypeCoordinate ()
 
int setTypeCoordinate (bool value)
 
ValueType getValueType ()
 
Fieldmodule getFieldmodule () const
 
int assignMeshLocation (const Fieldcache &cache, const Element &element, int coordinatesCount, const double *coordinatesIn)
 
int assignReal (const Fieldcache &cache, int valuesCount, const double *valuesIn)
 
int assignString (const Fieldcache &cache, const char *stringValue)
 
Element evaluateMeshLocation (const Fieldcache &cache, int coordinatesCount, double *coordinatesOut)
 
int evaluateReal (const Fieldcache &cache, int valuesCount, double *valuesOut)
 
char * evaluateString (const Fieldcache &cache)
 
int evaluateDerivative (const Differentialoperator&differentialOperator, const Fieldcache &cache, int valuesCount, double *valuesOut)
 
bool isDefinedAtLocation (const Fieldcache &cache)
 
int smooth (const Fieldsmoothing &fieldsmoothing)
 
FieldComponent castComponent ()
 
FieldEdgeDiscontinuity castEdgeDiscontinuity ()
 
FieldEigenvalues castEigenvalues ()
 
FieldElementGroup castElementGroup ()
 
FieldFindMeshLocation castFindMeshLocation ()
 
FieldFiniteElement castFiniteElement ()
 
FieldGroup castGroup ()
 
FieldImage castImage ()
 
FieldImagefilterBinaryThreshold castImagefilterBinaryThreshold ()
 
FieldImagefilterDiscreteGaussian castImagefilterDiscreteGaussian ()
 
FieldImagefilterHistogram castImagefilterHistogram ()
 
FieldImagefilterThreshold castImagefilterThreshold ()
 
FieldMeshIntegral castMeshIntegral ()
 
FieldNodeGroup castNodeGroup ()
 
FieldStoredMeshLocation castStoredMeshLocation ()
 
FieldStoredString castStoredString ()
 

Additional Inherited Members

- Public Types inherited from OpenCMISS::Zinc::Field
enum  ChangeFlag {
  CHANGE_FLAG_NONE = CMZN_FIELD_CHANGE_FLAG_NONE, CHANGE_FLAG_ADD = CMZN_FIELD_CHANGE_FLAG_ADD, CHANGE_FLAG_REMOVE = CMZN_FIELD_CHANGE_FLAG_REMOVE, CHANGE_FLAG_IDENTIFIER = CMZN_FIELD_CHANGE_FLAG_IDENTIFIER,
  CHANGE_FLAG_DEFINITION = CMZN_FIELD_CHANGE_FLAG_DEFINITION, CHANGE_FLAG_FULL_RESULT = CMZN_FIELD_CHANGE_FLAG_FULL_RESULT, CHANGE_FLAG_PARTIAL_RESULT = CMZN_FIELD_CHANGE_FLAG_PARTIAL_RESULT, CHANGE_FLAG_RESULT = CMZN_FIELD_CHANGE_FLAG_RESULT,
  CHANGE_FLAG_FINAL = CMZN_FIELD_CHANGE_FLAG_FINAL
}
 
enum  CoordinateSystemType {
  COORDINATE_SYSTEM_TYPE_INVALID = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_INVALID, COORDINATE_SYSTEM_TYPE_RECTANGULAR_CARTESIAN = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_RECTANGULAR_CARTESIAN, COORDINATE_SYSTEM_TYPE_CYLINDRICAL_POLAR = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_CYLINDRICAL_POLAR, COORDINATE_SYSTEM_TYPE_SPHERICAL_POLAR = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_SPHERICAL_POLAR,
  COORDINATE_SYSTEM_TYPE_PROLATE_SPHEROIDAL = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_PROLATE_SPHEROIDAL, COORDINATE_SYSTEM_TYPE_OBLATE_SPHEROIDAL = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_OBLATE_SPHEROIDAL, COORDINATE_SYSTEM_TYPE_FIBRE = CMZN_FIELD_COORDINATE_SYSTEM_TYPE_FIBRE
}
 
enum  DomainType {
  DOMAIN_TYPE_INVALID = CMZN_FIELD_DOMAIN_TYPE_INVALID, DOMAIN_TYPE_POINT = CMZN_FIELD_DOMAIN_TYPE_POINT, DOMAIN_TYPE_NODES = CMZN_FIELD_DOMAIN_TYPE_NODES, DOMAIN_TYPE_DATAPOINTS = CMZN_FIELD_DOMAIN_TYPE_DATAPOINTS,
  DOMAIN_TYPE_MESH1D = CMZN_FIELD_DOMAIN_TYPE_MESH1D, DOMAIN_TYPE_MESH2D = CMZN_FIELD_DOMAIN_TYPE_MESH2D, DOMAIN_TYPE_MESH3D = CMZN_FIELD_DOMAIN_TYPE_MESH3D, DOMAIN_TYPE_MESH_HIGHEST_DIMENSION = CMZN_FIELD_DOMAIN_TYPE_MESH_HIGHEST_DIMENSION
}
 
enum  ValueType { VALUE_TYPE_INVALID = CMZN_FIELD_VALUE_TYPE_INVALID, VALUE_TYPE_REAL = CMZN_FIELD_VALUE_TYPE_REAL, VALUE_TYPE_STRING = CMZN_FIELD_VALUE_TYPE_STRING, VALUE_TYPE_MESH_LOCATION = CMZN_FIELD_VALUE_TYPE_MESH_LOCATION }
 
typedef int ChangeFlags
 
typedef int DomainTypes
 
- Protected Attributes inherited from OpenCMISS::Zinc::Field
cmzn_field_id id
 

Detailed Description

Image processing derived field type performing the ITK histogram field.

Image processing derived field type performing the ITK histogram field.

Member Function Documentation

int OpenCMISS::Zinc::FieldImagefilterHistogram::getComputeMaximumValues ( int  valuesCount,
double *  valuesOut 
)
inline

Gets the maximum values to be computed for generating the histogram.

See Also
FieldImagefilterHistogram::setComputeMaximumValues
Parameters
valuesCountThe size of the maximum_values array to fill. Values for component beyond the size set use the last value.
valuesOutArray to receive maximum_values.
Returns
The actual number of maximum_values, this should be the same as the number of source components Returns 0 on error.
int OpenCMISS::Zinc::FieldImagefilterHistogram::getComputeMinimumValues ( int  valuesCount,
double *  valuesOut 
)
inline

Gets the minimum values to be computed for generating the histogram.

See Also
FieldImagefilterHistogram::setComputeMinimumValues
Parameters
valuesCountThe size of the minimum_values array to fill. Values for component beyond the size set use the last value.
valuesOutArray to receive minimum_values.
Returns
The actual number of minimum_values, this should be the same as the number of source components Returns 0 on error.
double OpenCMISS::Zinc::FieldImagefilterHistogram::getMarginalScale ( )
inline

Get the marginal scale value for this image filter. The Marginal scale is used to define a fraction of the bin width to be used as a tolerance around the upper bound of the bin.

See Also
FieldImagefilterHistogram::setMarginalScale
Returns
The current marginal value, or 0.0 on error.
int OpenCMISS::Zinc::FieldImagefilterHistogram::getNumberOfBins ( int  valuesCount,
int *  valuesOut 
)
inline

Gets the number of bins used to generate histogram. Higher number of bins increase the density and gives greater precision to the density estimation.

See Also
FieldImagefilterHistogram::setNumberOfBins
Parameters
valuesCountThe size of the number_of_bins array to fill. Values for component beyond the size set use the last value.
valuesOutArray to receive numbers of bins.
Returns
The actual number of number of bin values, this should be the same as the number of source components Returns 0 on error.
int OpenCMISS::Zinc::FieldImagefilterHistogram::setComputeMaximumValues ( int  valuesCount,
const double *  valuesIn 
)
inline

Sets the maximum values to be computed for generating the histogram. The default maximum values for new histogram filter is 1.0 for each source component. Note: The value set for the last source component applies to higher order components.

Parameters
valuesCountThe size of the valuesIn array, >= 1.
valuesInArray of maximum values (>=1) for each source component, with the last number in array applying to all higher order components.
Returns
Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.
int OpenCMISS::Zinc::FieldImagefilterHistogram::setComputeMinimumValues ( int  valuesCount,
const double *  valuesIn 
)
inline

Sets the minimum values to be computed for generating the histogram. The default minimum values for new histogram filter is 0.0 for each source component. Note: The value set for the last source component applies to higher order components.

Parameters
valuesCountThe size of the valuesIn array, >= 1.
valuesInArray of minimum values (>=1) for each source component, with the last number in array applying to all higher order components.
Returns
Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.
int OpenCMISS::Zinc::FieldImagefilterHistogram::setMarginalScale ( double  marginalScale)
inline

Set the marginal scale value for this image filter. The Marginal scale is used to define a fraction of the bin width to be used as a tolerance around the upper bound of the bin. The default marginal_scale for new histogram filter is 10.

Parameters
marginalScaleThe marginal_scale value to be set.
Returns
Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.
int OpenCMISS::Zinc::FieldImagefilterHistogram::setNumberOfBins ( int  valuesCount,
const int *  valuesIn 
)
inline

Sets the number of bins used to generate histogram. Higher number of bins increase the density and gives greater precision to the density estimation. This value can be set for each source field component. The default number of bins for new histogram filter is 64 for each source component. Note: The value set for the last source component applies to higher order components.

Parameters
valuesCountThe size of the valuesIn array, >= 1.
valuesInArray of number of bins (>=1) for each source component, with the last number in array applying to all higher order components.
Returns
Status OpenCMISS::Zinc::OK on success, otherwise OpenCMISS::Zinc::ERROR_ARGUMENT.

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