All Frameworks  Class Hierarchy  This Framework  Indexes   

CATAnalysisVisuInterfaces Interface CATISamImageFilters

Usage: an implementation of this interface is supplied and you must use it as is. You should not reimplement it.


interface CATISamImageFilters

Analysis Images modification.
Role: Analysis Images have a default definition.
But modifications may be done :
For example change the filters (components,layers,lamina,...), the selections,...
Query this interface in order to make some changes to an existing Image.


Method Index


o GetAllAvailableFilterDomain(CATSamFilterDomain*&,int&)
Retrieves all available filter domains for this image
Used on hybrid model to define where filters have to be applied
That is : on Volumic , on Surfacic or on Lineic part
Retrieves also the current filter domain
o GetAxisSystem(CATSamFilterDomain,CATISamImageAxisSystem*&)
Retrieves the axis system used for image computation.
o GetCombinationMode(CATBoolean&)
Retrieves the current combination mode to use in this image
o GetComplexPart(CATSamComplexPart&,float&)
Retrieves the current filter used for complex values
o GetComponentLabels(CATSamFilterDomain,CATListOfInt&,CATListOfCATUnicodeString&)
Retrieves the NLS strings associated to code components for this image
Note: Because of hybrid model you'll have to define first the filter domain
o GetComponent(CATSamFilterDomain,int&)
Retrieves the current selected components for this image
Note: Because of hybrid model you'll have to define first the filter domain
o GetCurrentRepeat(int&)
Retrieves the current repeat number.
o GetKeepOnlyParameters(CATBoolean&,CATBoolean&,CATSamComparisonOperator&,double&,double&)
Retrieves the current status of the keep only filter.
o GetLamina(CATSamFilterDomain,int&)
Retrieves the current lamina for this image
Note: Because of hybrid model you'll have to define first the filter domain
o GetLayer(CATSamFilterDomain,int&)
Retrieves the current layer for this image
Note: Because of hybrid model you'll have to define first the filter domain
o GetPosition(CATString&)
Retrieves the current position for this image
that is for a given visutype and a given criteria
o GetValueType(CATSamValue&)
Retrieves the current value type used in this image
o SetCombinationMode(CATBoolean)
Defines the current combination mode to use in this image
o SetComplexPart(CATSamComplexPart,float)
Sets the current filter used for complex values
o SetComponent(CATSamFilterDomain,int)
Sets the components to select for this image
Note: Because of hybrid model you'll have to define first the filter domain
o SetCurrentRepeat(int)
Defines the current repeat number.
o SetKeepOnlyParameters(CATBoolean,CATBoolean,CATSamComparisonOperator,double,double)
Retrieves the current status of the keep only filter.
o SetLamina(CATSamFilterDomain,int)
Sets the new lamina for this image
Note: Because of hybrid model you'll have to define first the filter domain
o SetLayer(CATSamFilterDomain,int)
Defines a new layer for this image
Note: Because of hybrid model you'll have to define first the filter domain
o SetPosition(CATString)
Defines the current position for this image
that is for a given visutype and a given criteria
o SetValueType(CATSamValue)
Defines the current value type to use in this image

Methods


o GetAllAvailableFilterDomain
public virtual GetAllAvailableFilterDomain( oFilterDomain,
oNbFilter)
Retrieves all available filter domains for this image
Used on hybrid model to define where filters have to be applied
That is : on Volumic , on Surfacic or on Lineic part
Retrieves also the current filter domain
Parameters:
oFilterDomain
the list of available filter domains
oNbFilter
Number of supported filter domains
See also:
CATSamFilterDomain
o GetAxisSystem
public virtual GetAxisSystem( iFilterDomain,
oAxisSystem)
Retrieves the axis system used for image computation.
Parameters:
iFilterDomain
the targeted FilterDomain
oAxisSystem
the axis system
See also:
CATISamImageAxisSystem
o GetCombinationMode
public virtual GetCombinationMode( oMode)
Retrieves the current combination mode to use in this image
Parameters:
iMode
the new combination mode
o GetComplexPart
public virtual GetComplexPart( oComplexPart,
oParameter)
Retrieves the current filter used for complex values
Parameters:
oComplexPart
the current complex filter
oParameter
the parameter associated to complex part (angle for modulus with phase)
See also:
CATSamComplexPart
o GetComponentLabels
public virtual GetComponentLabels( iFilterDomain,
iListCodeComponent,
oListComponentLabels)
Retrieves the NLS strings associated to code components for this image
Note: Because of hybrid model you'll have to define first the filter domain
Parameters:
iFilterDomain
The FilterDomain concerned
iListCodeComponent
list of component codes concerned CodeComponent = Sum(2**n) for the n current selected components
Default value: all components selected.:
oCodeComponent=2+4+8+16+32+64+128+256+512
oCodeComponent=0 will be interpreted as ALL COMPONENTS
Code components depends on the mathematical type of the characteristic
Code components depends on the current visutype and criteria
oListComponentLabels
the list of NLS strings associated to the given list of component codes
See also:
CATSamFilterDomain
o GetComponent
public virtual GetComponent( iFilterDomain,
oCodeComponent)
Retrieves the current selected components for this image
Note: Because of hybrid model you'll have to define first the filter domain
Parameters:
iFilterDomain
The FilterDomain concerned
oCodeComponent
oCodeComponent = Sum(2**n) for the n current selected components
Default value: all components selected.:
oCodeComponent=2+4+8+16+32+64+128+256+512
oCodeComponent=0 will be interpreted as ALL COMPONENTS
Code components depends on the mathematical type of the characteristic
Code components depends on the current visutype and criteria
See also:
CATSamFilterDomain
o GetCurrentRepeat
public virtual GetCurrentRepeat( oRepeat)
Retrieves the current repeat number.
To use only when combination mode has been set to FALSE
( that is, when values are not combined ).
Parameters:
iRepeat
the repeat number
o GetKeepOnlyParameters
public virtual GetKeepOnlyParameters( oStatus,
oAbsoluteMode,
oCriteria,
oValue,
oSndValue)
Retrieves the current status of the keep only filter.
WARNING: To use only when the mathematical type of image is scalar or vector and
the image does not have discrete values
Parameters:
oStatus
the status
oAbsoluteMode
the absolute mode oAbsoluteMode = TRUE means that filter is applied on absolute values oAbsoluteMode = FALSE means that filter is applied on actual values
oCriteria
the criteria
See also:
CATSamFilterCriteria
oValue
the value for filtering
oSndValue
the second value for filtering (used for "between" and "not between" operators)
o GetLamina
public virtual GetLamina( iFilterDomain,
oLamina)
Retrieves the current lamina for this image
Note: Because of hybrid model you'll have to define first the filter domain
Parameters:
iFilterDomain
The FilterDomain concerned
oLamina
the current lamina number
See also:
CATSamFilterDomain
o GetLayer
public virtual GetLayer( iFilterDomain,
oCodeLayer)
Retrieves the current layer for this image
Note: Because of hybrid model you'll have to define first the filter domain
Parameters:
iFilterDomain
The FilterDomain concerned
oCodeLayer
Legal values: for SUPERIOR layer is 2**1
Legal values: for MIDDLE layer is 2**2
Legal values: for INFERIOR layer is 2**3
Legal values: for all layers is Sum(2**n) for the n available layers
oCodeLayer=0 will be interpreted as ALL LAYERS
See also:
CATSamFilterDomain
o GetPosition
public virtual GetPosition( oPosition)
Retrieves the current position for this image
that is for a given visutype and a given criteria
Parameters:
oPosition
the current Position
o GetValueType
public virtual GetValueType( oValueType)
Retrieves the current value type used in this image
Parameters:
oValueType
the current value type
o SetCombinationMode
public virtual SetCombinationMode( iMode)
Defines the current combination mode to use in this image
Parameters:
iMode
the new combination mode
o SetComplexPart
public virtual SetComplexPart( iComplexPart,
const iParameter= 0.f )
Sets the current filter used for complex values
Parameters:
iComplexPart
the current complex filter
iParameter
the parameter associated to complex part (angle for modulus with phase)
See also:
CATSamComplexPart
o SetComponent
public virtual SetComponent( iFilterDomain,
iCodeComponent)
Sets the components to select for this image
Note: Because of hybrid model you'll have to define first the filter domain
Parameters:
iFilterDomain
The FilterDomain concerned
iCodeComponent
iCodeComponent = Sum(2**n) for the n components to select
Default value: all components selected.:
iCodeComponent=2+4+8+16+32+64+128+256+512
iCodeComponent=0 will be interpreted as ALL COMPONENTS
Code components depends on the mathematical type of the characteristic
Code components depends on the current visutype and criteria
See also:
CATSamFilterDomain
o SetCurrentRepeat
public virtual SetCurrentRepeat( iRepeat)
Defines the current repeat number.
To use only when combination mode has been set to FALSE
( that is, when values are not combined ).
Parameters:
iRepeat
the repeat number iRepeat = -1 will be interpreted as ALL REPEATS and makes sense for SYMBOL visualization mode only.
o SetKeepOnlyParameters
public virtual SetKeepOnlyParameters( iStatus,
iAbsoluteMode,
iCriteria,
const iValue,
const iSndValue= 0. )
Retrieves the current status of the keep only filter.
WARNING: To use only when the mathematical type of image is scalar or vector and
the image does not have discrete values
Parameters:
iStatus
the status
iAbsoluteMode
the absolute mode iAbsoluteMode = TRUE means that filter is applied on absolute values iAbsoluteMode = FALSE means that filter is applied on actual values
iCriteria
the criteria
See also:
CATSamFilterCriteria
iValue
the value for filtering
iSndValue
the second value for filtering (used for "between" and "not between" operators).
o SetLamina
public virtual SetLamina( iFilterDomain,
iLamina)
Sets the new lamina for this image
Note: Because of hybrid model you'll have to define first the filter domain
Parameters:
iFilterDomain
The FilterDomain concerned
iLamina
the new lamina number
See also:
CATSamFilterDomain
o SetLayer
public virtual SetLayer( iFilterDomain,
iCodeLayer)
Defines a new layer for this image
Note: Because of hybrid model you'll have to define first the filter domain
Parameters:
iFilterDomain
The FilterDomain concerned
iCodeLayer
Legal values: for SUPERIOR layer is 2**1 = 2
Legal values: for MIDDLE layer is 2**2 = 4
Legal values: for INFERIOR layer is 2**3 = 8
Legal values: for SUPERIOR and INFERIOR layers is 2**1+2**3 = 10
Legal values: for all layers is Sum(2**n) for the n available layers
iCodeLayer=0 will be interpreted as ALL LAYERS
See also:
CATSamFilterDomain
o SetPosition
public virtual SetPosition( iPosition)
Defines the current position for this image
that is for a given visutype and a given criteria
Parameters:
iPosition
the new Position
o SetValueType
public virtual SetValueType( iValueType)
Defines the current value type to use in this image
Parameters:
iValueType
the new value type

This object is included in the file: CATISamImageFilters.h
If needed, your Imakefile.mk should include the module: CATSamVisuUUID

Copyright © 2003, Dassault Systèmes. All rights reserved.