ml::DicomTreeDefaultValidation Class Reference

Class implementing some generic DICOM tree checks. More...

#include <mlDicomTreeDefaultValidation.h>

Inheritance diagram for ml::DicomTreeDefaultValidation:

Public Member Functions
	DicomTreeDefaultValidation ()
	Constructor.
virtual std::string	validateDCMTree (DCMTree::Const_TreePtr dcmTree, std::string &warnings) override
	Applies some basic validation on dcmTree and returns a non empty string if they fail; otherwise an empty string is returned for success.
void	setValueSizeCheckOn (bool check)
	If true then the size of tag values are checked against allowed sizes.
bool	isValueSizeCheckOn () const
	Returns true if tag value sizes are checked, otherwise false.
void	setValueMultiplicityCheckOn (bool check)
	If true then the tag value multiplicity is checked, otherwise not; default is false.
bool	isValueMultiplicityCheckOn () const
	Returns true if tag value multiplicity is checked, otherwise false.
void	setValueRepresentationCheckOn (bool check)
	If true (the default) then the tag value representation is checked, otherwise not.
bool	isValueRepresentationCheckOn () const
	Returns true if tag value representation is checked, otherwise false.
void	setTypeOneCheckOn (bool check)
	If true (the default) then the tag value representation is checked, otherwise not.
bool	isTypeOneCheckOn () const
	Returns true if tag value representation is checked, otherwise false.
void	setCheckCommonSettingsOn (bool check)
	If true (the default) then a number of common value settings are checked, otherwise not.
bool	isCheckCommonSettingsOn () const
	Returns true if checks of common settings are enabled, otherwise false.
void	setWarnUnknownEnumeratorItemsOn (bool warn)
	If true (the default) then enumerator tag values which are not given as defined terms in the standard will be warned, otherwise not.
bool	isWarnEnumeratorItemsOn () const
	Returns true if unknown enumerator items will be warned, otherwise false.
Public Member Functions inherited from ml::DicomTreeValidationBase
	DicomTreeValidationBase ()
	Constructor.
virtual	~DicomTreeValidationBase ()
	Destructor.
BaseField &	getInputDCMTreeValidatorFld () const
	Access to input base field.
BaseField &	getOutputDCMTreeValidatorFld () const
	Access to output base field.
Public Member Functions inherited from ml::Module
MLMetaProfilePtr &	getMetaProfile () const
	Returns the meta profile for the base operator.
const char *	getTypeNameFast () const
	Macro to declare methods for the ML runtime type system (see mlRuntimeSubClass.h).
	Module (int numInputImages, int numOutputImages)
	Constructor: Initializes numInputImages input images and numOutputImages output images of the module.
	~Module () override
	Destructor: Destroys this module.
InputConnectorField *	getInputImageField (MLint i) const
	Returns the field representing input image i. i must be a valid index.
OutputConnectorField *	getOutputImageField (MLint i=0) const
	Returns field representing output image i. i must be a valid index.
MLint	getNumInputImages () const
	Returns number of input images of this module.
MLint	getNumOutputImages () const
	Returns number of output images of this module.
PagedImage *	getOutputImage (MLint outputIndex=0) const
	Returns output image outputIndex. The index needs to be in the range [0, getNumOutputImages()-1].
InputConnectorField *	addInputImage (const char *name=nullptr)
	Adds a new input image with name to the module.
OutputConnectorField *	addOutputImage (const char *name=nullptr)
	Adds a new output image with name to the module.
PagedImage *	getInputImage (MLint inputIndex, bool getReal=false) const
	Returns the output image of the module connected to input inputIndex.
PagedImage *	getUpdatedInputImage (MLint inputIndex, bool getReal=false) const
	Convenience method for safe access to the input image at index inputIndex.
MLErrorCode	processAllPages (int outputIndex=-1, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
	Processes all pages of a module for easy implementation of page-based image processing of complete images.
MLErrorCode	processAllPages (ProcessAllPagesHandler &handler, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
	Process input images with a ProcessAllPagesHandler handler on a temporary output image (which allocates no data) For details, see processAllPages(-1) above.
MLErrorCode	processMissingPages (int outputIndex=0, SubImageBox region=SubImageBox(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
	Processes all missing pages on the given output image.
void	clearOutputImage (MLint i=0)
	Clear cached output image pages of output image i.
MLint	getOutputImageInplace (MLint outputIndex=0) const
	Return optimization flag: Return index of input image whose input tile is used also as output page for output outputIndex in calculateOutputSubImage() (instead of allocating its own memory).
MLint	getBypass (MLint outputIndex=0) const
	Returns the currently bypass index or -1 if bypassing is disabled (default).
THREAD_SUPPORT	getThreadSupport () const
	Returns the multithreading mode supported by this module, default is NO_THREAD_SUPPORT.
bool	areRecursiveHandleNotificationsPermitted () const
	Returns if recursive entries in handleNotification are permitted.
MLint	getHandleNotificationEntryCounter () const
	A counter returning the current number of (recursive re)entries in handleNotification.
PERMITTED_TYPES	getVoxelDataTypeSupport () const
	Returns the current state of supported voxel data types.
bool	isSupportedVoxelDataType (MLDataType dt) const
	Check if a given data type is supported on the module as configured with setVoxelDataTypeSupport.
virtual INPUT_HANDLE	handleInput (int, INPUT_STATE) const
	This method may be reimplemented to enable support for invalid input images on the module.
INPUT_STATE	getInputState (MLint index)
	Returns the current state of the input connection.
INPUT_STATE	getUpdatedInputState (MLint index)
	Returns the updated state of the input image by calling updateImageProperties(index) and returning getInputState(index) afterwards.
bool	isInputImageField (Field *field) const
	Returns if the given field is an input image field. This can be used in handleNotification(), to check if one of the input images has changed.
void	touchOutputImageFields () const
	Touch all output image fields to indicate that the images have changed.
virtual void	beginSaveFields ()
	Called before all fields data contents of this modules are saved.
virtual void	endSaveFields ()
	Called after saving all field contents of this module.
Public Member Functions inherited from ml::FieldContainer
	FieldContainer ()
	Constructor.
	~FieldContainer () override
	Destructor: Deletes all added fields.
std::string	whoAmI (bool withInstanceName=true) const
	Returns type and instance name of format "ClassTypeName(instanceName)" if the instance name is not empty and withInstanceName is true.
Field *	addField (const char *name, const char *type, const char *value)
	Adds a new field with name name, type type and value value (coded as string) to the container.
Field *	addField (Field *field)
	Adds a field, the ownership of the field is passed to the FieldContainer.
BoolField *	addBool (const char *name)
	Creates a BoolField with name and adds it to the container. Default value is false.
BoolField *	addBool (const char *name, bool value)
	Creates a BoolField with name and adds it to the container.
IntField *	addInt (const char *name)
	Creates an IntField with name and adds it to the container. Default value is 0.
IntField *	addInt (const char *name, MLint value)
	Creates an IntField with name and adds it to the container.
EnumField *	addEnum (const char *name, const char *const *enumerationItemNames, MLint numEnumerationItems)
	Creates an EnumField field with name and adds it to the container.
EnumField *	addEnum (const char *name, const std::vector< std::string > &enumerationItemNames)
	Creates an EnumField field with name and adds it to the container.
template<typename EnumType >
TypedEnumField< EnumType > *	addEnum (const char *name, const EnumValues< EnumType > &values, EnumType initialValue)
	Creates a TypedEnumField field with name and adds it to the container.
FloatField *	addFloat (const char *name)
	Creates a FloatField with name and adds it to the container. Default value is 0.f.
FloatField *	addFloat (const char *name, float value)
	Creates a FloatField with name and adds it to the container.
ProgressField *	addProgress (const char *name)
	Creates a float ProgressField with name and adds it to the container. Default value is 0.f.
ProgressField *	addProgress (const char *name, float value)
	Creates a float ProgressField with name and adds it to the container.
DoubleField *	addDouble (const char *name)
	Creates a DoubleField with name and adds it to the container. Default value is 0.
DoubleField *	addDouble (const char *name, double value)
	Creates a DoubleField with name and adds it to the container.
StringField *	addString (const char *name)
	Creates a StringField with name and adds it to the container. Default value is empty string.
StringField *	addString (const char *name, const std::string &value)
	Creates a StringField with name and adds it to the container.
NotifyField *	addNotify (const char *name)
	Creates a NotifyField field with name and adds it to the container.
TriggerField *	addTrigger (const char *name)
	Creates a TriggerField field with name and adds it to the container.
BaseField *	addBase (const char *name)
	Creates a Base field with name and adds it to the container. Default value is NULL.
BaseField *	addBase (const char *name, Base *value)
	Creates a Base field with name and adds it to the container.
BaseField *	addBase (const char *name, const RefCountedBasePtr &value)
	Creates a Base field with name and adds it to the container. Sets the value from intrusive pointer.
template<typename T >
BaseField *	addBaseWithAllowedType (const char *name, T *value=nullptr)
	As above, but also sets the allowed type of the field.
template<typename T >
BaseField *	addBaseWithAllowedType (const char *name, const ::boost::intrusive_ptr< T > &value)
	As above, but also sets the allowed type of the field.
template<typename T >
TypedBaseField< T > *	addTypedBase (const char *name)
	Creates a TypedBaseField with name and adds it to the container. Default value is NULL.
template<typename T >
TypedBaseField< T > *	addTypedBase (const char *name, T *value)
	Creates a TypedBaseField with name and adds it to the container.
template<typename T >
TypedBaseField< T > *	addTypedBase (const char *name, const ::boost::intrusive_ptr< T > &value)
	Creates a TypedBaseField with name and adds it to the container. Sets the value from intrusive pointer.
SoNodeField *	addSoNode (const char *name)
	Creates a SoNodeField with name and adds it to the container. Default value is NULL.
SoNodeField *	addSoNode (const char *name, SoNode *value)
	Creates a SoNodeField with name and adds it to the container.
PointerField *	addPointer (const char *name)
	Creates a PointerField with name and adds it to the container.
Vector2Field *	addVector2 (const char *name)
	Creates a Vector2Field with name and adds it to the container.
Vector2Field *	addVector2 (const char *name, const Vector2 &value)
	Creates a Vector2Field with name and adds it to the container.
Vector2Field *	addVector2 (const char *name, double x, double y)
	Creates a Vector2Field with name and adds it to the container.
Vector3Field *	addVector3 (const char *name)
	Creates a Vector3Field with name and adds it to the container.
Vector3Field *	addVector3 (const char *name, const Vector3 &value)
	Creates a Vector3Field with name and adds it to the container.
Vector3Field *	addVector3 (const char *name, double x, double y, double z)
	Creates a Vector3Field with name and adds it to the container.
Vector4Field *	addVector4 (const char *name)
	Creates a Vector4Field with name and adds it to the container.
Vector4Field *	addVector4 (const char *name, const Vector4 &value)
	Creates a Vector4Field with name and adds it to the container.
Vector4Field *	addVector4 (const char *name, double x, double y, double z, double w)
	Creates a Vector4Field with name and adds it to the container.
Vector5Field *	addVector5 (const char *name)
	Creates a Vector5Field with name and adds it to the container.
Vector5Field *	addVector5 (const char *name, const Vector5 &value)
	Creates a Vector5Field with name and adds it to the container.
Vector6Field *	addVector6 (const char *name)
	Creates a Vector6Field with name and adds it to the container.
Vector6Field *	addVector6 (const char *name, const Vector6 &value)
	Creates a Vector6Field with name and adds it to the container.
Vector10Field *	addVector10 (const char *name)
	Creates a Vector10Field with name and adds it to the container.
Vector10Field *	addVector10 (const char *name, const Vector10 &value)
	Creates a Vector10Field with name and adds it to the container.
ImageVectorField *	addImageVector (const char *name)
	Creates a ImageVectorField with name and adds it to the container.
ImageVectorField *	addImageVector (const char *name, const ImageVector &value)
	Creates a ImageVectorField with name and adds it to the container.
ImageVectorField *	addImageVector (const char *name, MLint x, MLint y, MLint z, MLint c, MLint t, MLint u)
	Creates a ImageVectorField with name and adds it to the container.
SubImageBoxField *	addSubImageBox (const char *name)
	Creates a SubImageBoxField with name and adds it to the container.
SubImageBoxField *	addSubImageBox (const char *name, const SubImageBox &value)
	Creates a SubImageBoxField with name and adds it to the container.
SubImageBoxdField *	addSubImageBoxd (const char *name)
	Creates a SubImageBoxd field with name and adds it to the container.
SubImageBoxdField *	addSubImageBoxd (const char *name, const SubImageBoxd &value)
	Creates a SubImageBoxd field with name and adds it to the container.
ColorField *	addColor (const char *name)
	Creates a ColorField with name and adds it to the container.
ColorField *	addColor (const char *name, float r, float g, float b)
	Creates a ColorField with name and adds it to the container.
ColorField *	addColor (const char *name, const Vector3 &value)
	Creates a ColorField with name and adds it to the container.
PlaneField *	addPlane (const char *name)
	Creates a PlaneField with name and adds it to the container.
PlaneField *	addPlane (const char *name, double f0, double f1, double f2, double f3)
	Creates a PlaneField with name and adds it to the container.
PlaneField *	addPlane (const char *name, const Plane &value)
	Creates a PlaneField with name and adds it to the container.
RotationField *	addRotation (const char *name)
	Creates a RotationField with name and adds it to the container.
RotationField *	addRotation (const char *name, const Rotation &value)
	Creates a RotationField with name and adds it to the container.
Matrix2Field *	addMatrix2 (const char *name)
	Creates a Matrix2Field with name and adds it to the container.
Matrix2Field *	addMatrix2 (const char *name, const Matrix2 &value)
	Creates a Matrix2Field with name and adds it to the container.
Matrix3Field *	addMatrix3 (const char *name)
	Creates a Matrix3Field with name and adds it to the container.
Matrix3Field *	addMatrix3 (const char *name, const Matrix3 &value)
	Creates a Matrix3Field with name and adds it to the container.
Matrix4Field *	addMatrix4 (const char *name)
	Creates a Matrix4Field with name and adds it to the container.
Matrix4Field *	addMatrix4 (const char *name, const Matrix4 &value)
	Creates a Matrix4Field with name and adds it to the container.
Matrix5Field *	addMatrix5 (const char *name)
	Creates a Matrix5Field with name and adds it to the container.
Matrix5Field *	addMatrix5 (const char *name, const Matrix5 &value)
	Creates a Matrix5Field with name and adds it to the container.
Matrix6Field *	addMatrix6 (const char *name)
	Creates a Matrix6Field with name and adds it to the container.
Matrix6Field *	addMatrix6 (const char *name, const Matrix6 &value)
	Creates a Matrix6Field with name and adds it to the container.
MatrixField *	addMatrix (const char *name)
	Creates a MatrixField with name and adds it to the container.
MatrixField *	addMatrix (const char *name, const Matrix4 &value)
	Creates a MatrixField with name and adds it to the container.
MLDataTypeField *	addMLDataType (const char *name)
	Creates a MTDataTypeField with name and adds it to the container.
MLDataTypeField *	addMLDataType (const char *name, MLDataType value)
	Creates a MTDataTypeField with name and adds it to the container.
UniversalTypeField *	addUniversalType (const char *name)
	Creates an UniversalTypeField field with name and adds it to the container.
IntListField *	addIntList (const char *name)
	Creates an IntListField field with name and empty list value and adds it to the container.
IntListField *	addIntList (const char *name, const std::vector< MLint > &value)
	Creates an IntListField field with name and given list value and adds it to the container.
DoubleListField *	addDoubleList (const char *name)
	Creates an DoubleListField field with name and empty list value and adds it to the container.
DoubleListField *	addDoubleList (const char *name, const std::vector< double > &value)
	Creates an DoubleListField field with name and given list value and adds it to the container.
Vector2ListField *	addVector2List (const char *name)
	Creates an Vector2ListField field with name and empty list value and adds it to the container.
Vector2ListField *	addVector2List (const char *name, const std::vector< Vector2 > &value)
	Creates an Vector2ListField field with name and given list value and adds it to the container.
Vector3ListField *	addVector3List (const char *name)
	Creates an Vector3ListField field with name and empty list value and adds it to the container.
Vector3ListField *	addVector3List (const char *name, const std::vector< Vector3 > &value)
	Creates an Vector3ListField field with name and given list value and adds it to the container.
Vector4ListField *	addVector4List (const char *name)
	Creates an Vector4ListField field with name and empty list value and adds it to the container.
Vector4ListField *	addVector4List (const char *name, const std::vector< Vector4 > &value)
	Creates an Vector4ListField field with name and given list value and adds it to the container.
size_t	getNumFields () const
	Returns the number of added fields.
bool	hasField (const std::string &name) const
	Returns true if the field with name name exists; otherwise false is returned.
Field *	getField (const std::string &name) const
	Returns the pointer to the field with name name.
Field *	getField (MLint index) const
	Returns pointer of field at index if it exists. If not, -1 is returned.
MLint	getFieldIndex (Field *field) const
	Returns index of field if it exists. If not, -1 is returned.
void	setFieldStringValue (const std::string &name, const std::string &value)
	Sets the value of the field with name if it exists.
std::string	getFieldStringValue (const std::string &name) const
	Returns the string value of the field with name if it is found.
virtual void	activateAttachments ()
	Reactivates notification handling, i.e., all fields of this module will send notifications again to attached sensors and fields if their value is set or changed.
virtual void	deactivateAttachments ()
	Disables notification handling, i.e., all fields of this module will not send notifications to attached sensors and fields any more if their values are set or changed.
Public Member Functions inherited from ml::Base
	Base ()
	Constructor.
virtual	~Base ()
	Destructor.
virtual Base *	deepCopy () const
	Set addStateToTree version number that can be accessed via getAddStateVersion()
bool	isOfAllowedType (const std::vector< const RuntimeType * > &types) const
	Check if this object's type is equal to or derived from one of the types given in the argument.
virtual bool	isRefCountedBase () const
	Returns if the instance is derived from RefCountedBase.
virtual std::string	detailString () const
	Return a string describing this object.
virtual bool	implementsPersistence (PersistenceInterface) const
	Override this method to declare which persistence interfaces are implemented by your derived class.
virtual std::string	persistentState () const
	Returns a string describing the object's internal state.
virtual void	setPersistentState (const std::string &state)
	Restores the object's internal state from a string that had been previously generated using persistentState().
virtual void	addStateToTree (TreeNode *) const
	Attaches the object state as children of the given parent node.
virtual void	readStateFromTree (TreeNode *)
	Reads the object state from the children of the given parent node.
virtual void	writeTo (AbstractPersistenceOutputStream *) const
	Write the objects state to the data stream object.
virtual void	readFrom (AbstractPersistenceInputStream *, int)
	Read the objects state from the data stream object.

Additional Inherited Members
Public Types inherited from ml::Module
enum	PERMITTED_TYPES { ONLY_SCALAR_TYPES , ONLY_DEFAULT_TYPES , ALL_REGISTERED_TYPES }
	See documentation of setVoxelDataTypeSupport. More...
enum	INPUT_STATE { DISCONNECTED = 0 , CONNECTED_BUT_INVALID = 1 , CONNECTED_AND_VALID = 2 , CONNECTED_BUT_NEEDS_UPDATE = 3 }
	See documentation of handleInput. More...
enum	INPUT_HANDLE { INVALIDATE = 0 , ALLOW_INVALID_INPUT = 2 }
	See documentation of handleInput. More...
Public Types inherited from ml::Base
enum	PersistenceInterface { PersistenceByString , PersistenceByTreeNode , PersistenceByStream }
	This enum describes the different persistence interfaces available. More...
Static Public Member Functions inherited from ml::Module
static MLErrorCode	getTile (PagedImage *image, SubImageBox loc, MLDataType datatype, void **data, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
	For documentation see Host::getTile() function with same signature.
static MLErrorCode	getTile (PagedImage *image, SubImage &subimg, const ScaleShiftData &scaleShiftData=ScaleShiftData(), MLRequestProgressCB *progressCallback=nullptr, void *progressCallbackUserData=nullptr)
	For documentation see Host::getTile() function with same signature and Module passed as reference.
static MLErrorCode	updateImageProperties (PagedImage *image)
	For documentation see Host::updateImageProperties() function with same signature.
static void	freeTile (void *data)
	For documentation see Host::freeTile().
static void	updateProgress (const char *info1, const char *info2)
	For documentation see Host::updateProgress().
static bool	shouldTerminate ()
	For documentation see Host::shouldTerminate().
static Field *	getPressedNotifyField ()
	For documentation see Host::getPressedNotifyField().
static void	adaptPageExtent (ImageVector &pageExtent, MLDataType imageType, const ImageVector &newImgExtent, const ImageVector &oldImgExtent, const ImageVector &pageUnit=ImageVector(0), const ImageVector &minPageExtent=ImageVector(0), const ImageVector &maxPageExtent=ImageVector(0))
	Adapt page size.
static std::string	getVoxelValueAsString (PagedImage *image, const ImageVector &position, MLErrorCode *errorCode=nullptr, const std::string &errorResult="")
	Returns the voxel value at position position of the image image.
static size_t	getNumModules ()
	Returns number of instantiated modules.
static Module *	getModule (size_t index)
	Returns pointer to instantiated module index.
static MLint	findModuleIndex (Module &module)
	Returns index of Module module. If not found -1 is returned.
static void	destroyModule ()
	Destroys static allocated tables to avoid memory leaks.
Protected Types inherited from ml::Module
enum	THREAD_SUPPORT { NO_THREAD_SUPPORT = PagedImage::NO_THREAD_SUPPORT , MULTITHREADED = PagedImage::MULTITHREADED , IO_THREAD = PagedImage::IO_THREAD }
	Enumerator deciding whether and which type of multithreading is supported by this module. More...
Protected Member Functions inherited from ml::DicomTreeValidationBase
	ML_ABSTRACT_MODULE_CLASS_HEADER (DicomTreeValidationBase)
	Implements interface for the runtime type system of the ML.
Protected Member Functions inherited from ml::Module
void	handleNotificationInternal (Field *field, FieldSensor::Strength strength) override
	Called from FieldContainer whenever a field changes.
virtual void	provideCustomPage (int, const SubImageBox &, MLMemoryBlockHandle &)
	This method allows a Module to provide its own pages to the Host for the outputIndex output image.
void	handleNotificationOff ()
	Decreases lock counter for handleNotification calls.
void	handleNotificationOn ()
	Increases lock counter for handleNotification calls.
bool	isHandleNotificationOn ()
	Returns true if handleNotification calls are permitted, otherwise false.
void	setOutputImageInplace (MLint outputIndex=0, MLint inputIndex=0)
	Set optimization flag: If calculating a page in calculateOutputSubImage(), the output image page of output outputIndex shall use the same memory as the input page of input inputIndex.
void	unsetOutputImageInplace (MLint outputIndex=0)
	Clear optimization flag: output page of output at outputIndex and input tile shall use different memory buffers in calculateOutputSubImage().
void	setBypass (MLint outputIndex=0, MLint inputIndex=0)
	Sets the input image whose pages can also be used instead of output pages for the output image at outputIndex to avoid recalculations.
void	setClampPagesToImageExtent (bool flag=true)
	Enables/disables page clamping on all output images.
void	setThreadSupport (THREAD_SUPPORT supportMode)
	Pass any THREAD_SUPPORT supportMode to decide whether and what type of multithreading is supported by this module.
void	permitRecursiveHandleNotifications (bool enable)
	If this flag is set to enable =true, recursive entries in handleNotification are permitted.
void	setVoxelDataTypeSupport (PERMITTED_TYPES permTypes)
	Specifies which types this module supports.
virtual void	handleNotification (Field *)
	Called when any field data in the field container of this module is modified.
virtual CalculateOutputImageHandler *	createCalculateOutputImageHandler (PagedImage *outputImage)
	Creates the CalculateOutputImageHandler for the given output image outputImage.
virtual void	calculateOutputImageProperties (int outputIndex, PagedImage *outputImage)
	Set properties of output image outputImage with output index outputIndex.
virtual SubImageBox	calculateInputSubImageBox (int, const SubImageBox &outputSubImageBox, int)
	Called by the Host to determine which input image region (tile) of input inputIndex is required to calculate a certain output image region (page) of output outputIndex.
virtual void	calculateOutputSubImage (SubImage *outputSubImage, int outputIndex, SubImage *inputSubImages)
	Calculate page outputSubImage of output image with index outputIndex given the input image tiles in array inputSubImages.
Protected Attributes inherited from ml::DicomTreeValidationBase
BaseField *	_inputDCMTreeValidatorFld
	Input connector field for other objects derived from DicomTreeValidationBase to be able to cascade validating modules.
BaseField *	_outputDCMTreeValidatorFld
	Output connector Base field providing this as object to be used by derived modules.

Detailed Description

Class implementing some generic DICOM tree checks.

Definition at line 22 of file mlDicomTreeDefaultValidation.h.

Constructor & Destructor Documentation

DicomTreeDefaultValidation()

ml::DicomTreeDefaultValidation::DicomTreeDefaultValidation

(

)

Constructor.

Member Function Documentation

isCheckCommonSettingsOn()

bool ml::DicomTreeDefaultValidation::isCheckCommonSettingsOn ( ) const

inline

Returns true if checks of common settings are enabled, otherwise false.

Definition at line 64 of file mlDicomTreeDefaultValidation.h.

isTypeOneCheckOn()

bool ml::DicomTreeDefaultValidation::isTypeOneCheckOn ( ) const

inline

Returns true if tag value representation is checked, otherwise false.

Definition at line 58 of file mlDicomTreeDefaultValidation.h.

isValueMultiplicityCheckOn()

bool ml::DicomTreeDefaultValidation::isValueMultiplicityCheckOn ( ) const

inline

Returns true if tag value multiplicity is checked, otherwise false.

Definition at line 46 of file mlDicomTreeDefaultValidation.h.

isValueRepresentationCheckOn()

bool ml::DicomTreeDefaultValidation::isValueRepresentationCheckOn ( ) const

inline

Returns true if tag value representation is checked, otherwise false.

Definition at line 52 of file mlDicomTreeDefaultValidation.h.

isValueSizeCheckOn()

bool ml::DicomTreeDefaultValidation::isValueSizeCheckOn ( ) const

inline

Returns true if tag value sizes are checked, otherwise false.

Definition at line 38 of file mlDicomTreeDefaultValidation.h.

isWarnEnumeratorItemsOn()

bool ml::DicomTreeDefaultValidation::isWarnEnumeratorItemsOn ( ) const

inline

Returns true if unknown enumerator items will be warned, otherwise false.

Definition at line 71 of file mlDicomTreeDefaultValidation.h.

setCheckCommonSettingsOn()

void ml::DicomTreeDefaultValidation::setCheckCommonSettingsOn ( bool check )

inline

If true (the default) then a number of common value settings are checked, otherwise not.

Definition at line 61 of file mlDicomTreeDefaultValidation.h.

References mlrange_cast().

setTypeOneCheckOn()

void ml::DicomTreeDefaultValidation::setTypeOneCheckOn ( bool check )

inline

If true (the default) then the tag value representation is checked, otherwise not.

Definition at line 55 of file mlDicomTreeDefaultValidation.h.

References mlrange_cast().

setValueMultiplicityCheckOn()

void ml::DicomTreeDefaultValidation::setValueMultiplicityCheckOn ( bool check )

inline

If true then the tag value multiplicity is checked, otherwise not; default is false.

Note that this check may produce a number of false positives - therefore its results should be considered only as a hint.

Definition at line 43 of file mlDicomTreeDefaultValidation.h.

References mlrange_cast().

setValueRepresentationCheckOn()

void ml::DicomTreeDefaultValidation::setValueRepresentationCheckOn ( bool check )

inline

If true (the default) then the tag value representation is checked, otherwise not.

Definition at line 49 of file mlDicomTreeDefaultValidation.h.

References mlrange_cast().

setValueSizeCheckOn()

void ml::DicomTreeDefaultValidation::setValueSizeCheckOn ( bool check )

inline

If true then the size of tag values are checked against allowed sizes.

Definition at line 35 of file mlDicomTreeDefaultValidation.h.

References mlrange_cast().

setWarnUnknownEnumeratorItemsOn()

void ml::DicomTreeDefaultValidation::setWarnUnknownEnumeratorItemsOn ( bool warn )

inline

If true (the default) then enumerator tag values which are not given as defined terms in the standard will be warned, otherwise not.

Definition at line 68 of file mlDicomTreeDefaultValidation.h.

References mlrange_cast().

validateDCMTree()

virtual std::string ml::DicomTreeDefaultValidation::validateDCMTree ( DCMTree::Const_TreePtr dcmTree, std::string & warnings )

overridevirtual

Applies some basic validation on dcmTree and returns a non empty string if they fail; otherwise an empty string is returned for success.

If warnings appears then warnings will be extended by the warning message, otherwise it will be left unchanged.

Reimplemented from ml::DicomTreeValidationBase.

---

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

• FMEwork/ReleaseMeVis/Projects/MLDicomAnalysisWork/Sources/mlDicomTreeDefaultValidation.h