Package empro :: Module empro :: Module sensor :: Class SARAveragingSensor

Class SARAveragingSensor

core.Updatable --+        
                 |        
   core.Selectable --+    
                     |    
                Sensor --+
                         |
                        SARAveragingSensor

A Sensor which collects mass-averaged Specific Absorption Rate (SAR) data from a simulation.

Class Hierarchy for SARAveragingSensor

constructor SARAveragingSensor():

Instance Methods

__call__(x, ...)
x(...)

None

addExtremityTissueMaterial(iMaterial)
Add a material to the list of extremity tissue materials.

bool

hasExtremityTissueMaterial(iMaterial)
Tests whether a material is in the list of extremity tissue materials.

bool

removeExtremityTissueMaterial(iMaterial)
Remove a material from the list of extremity tissue materials.

Inherited from core.Selectable: clone, isSelected

Inherited from core.Updatable: __enter__, __exit__, hash, isValid, reasonWhyInvalid

Properties
floatNone	avgAutoSubregionCutoffRatio Controls the cutoff threshold ratio for determination of the automatic subregion.
CoordinateSystemAbstractPositionNone	avgCorner1 First corner of the SAR region box.
CoordinateSystemAbstractPositionNone	avgCorner2 Second corner of the SAR region box.
boolNone	avgRegionType One of {AvgRegionTypeFullGrid,AvgRegionTypeBox}
boolNone	collect10gAvgSAR Controls whether 10g averaged SAR data should be collected or not.
boolNone	collect1gAvgSAR Controls whether 1g averaged SAR data should be collected or not.
`list`{Material}None	tissueMaterials Full list of extermity tissue materials.
stringNone	tissueMaterialsMode Controls which tissue materials are used in SAR averaging.
boolNone	treatRegionOutsideAvgBoxAsFreespace Controls whether space outside the averaging region is treated as freespace when the averaging region type is AvgRegionTypeBox.
Inherited from `Sensor`: `enabled`, `isEnabled`, `isVisible`, `visible` Inherited from `core.Selectable`: `metaData`, `name`, `notes`

Method Details

addExtremityTissueMaterial(iMaterial)

Add a material to the list of extremity tissue materials.

Parameters:

iMaterial (Material) - The material to add.

Returns: None

hasExtremityTissueMaterial(iMaterial)

Tests whether a material is in the list of extremity tissue materials.

Parameters:

iMaterial (Material) - The material to test.

Returns: bool

removeExtremityTissueMaterial(iMaterial)

Remove a material from the list of extremity tissue materials.

Parameters:

iMaterial (Material) - The material to remove.

Returns: bool

Property Details

avgAutoSubregionCutoffRatio

Controls the cutoff threshold ratio for determination of the automatic subregion. This value is the ratio between the maximum raw SAR in the grid and the minimum raw SAR which must be included in the averaging region. This ratio is NOT in dB internally, and should typically be a number greather than one. The engine looks like it expects a value in dBp (it does pow( 10, 0.1 * cutoffRatio_dB )

Type:: floatNone

tissueMaterialsMode

Controls which tissue materials are used in SAR averaging. {AllTissueMaterials,UserSelectedExtremityTissueMaterials}

Type:: stringNone