hermes.pipeline.components.cutprescanregion.cutPrescanRegion Class Reference

Reduces the image to the exposed part of the detector. More...

Inheritance diagram for hermes.pipeline.components.cutprescanregion.cutPrescanRegion:

Public Member Functions
def	__init__
	Make a Hermes component and initialize variables.
def	validateOptions
	check eventual options
def	__call__
	runs from here
Public Member Functions inherited from hermes.pipeline.core.pipelinecomponent.PipelineComponent
def	__init__
def	__call__
def	optionsAreValid
def	getOptions
def	setOptions
def	checkExistShapeUnits
def	isOption

Public Attributes
	results
Public Attributes inherited from hermes.pipeline.core.pipelinecomponent.PipelineComponent
	options
	logger
	ConsoleLogSeverity
	default value
	canShowGraphics
	when machine does not run matplotlib. More...

Detailed Description

Reduces the image to the exposed part of the detector.

PURPOSE :

Separates the exposed part of the detector from the prescan part of the image.
This module reduces the image to the exposed part of the detector, independently
of the fact where the prescan part is situated (first columns, first rows, last
columns, last rows)


COMMENTS :


SYNTAX :


INPUT CONSTANTS FROM INSTRUMENT MODEL :

position of prescan region



INPUT DATA FROM RESULTDICT :

MANDATORY :
    A rawimage-shaped image should be passed as input in self.results.rawImage
    The routine checks its size against the instrumentModel.



OPTIONS READ FROM OPTIONDICT :

MANDATORY :


NOT MANDATORY :



OUTPUT written in the RESULTDICT :

When success condition is met :
    the exposed part of input image in self.results.Image
    If a variance image "rawImageVariance" is found, it is also cut
    and "imageVariance" is written.

When success condition is not met :
    record the fatal error message and stop the chain.




SUCCESS CONDITIONS :



    RESULTDICT should provide the input information, usually
    coming from previously runned components.

    Size of the Input Image has to be the size of rawImage,
    according to the instrument configuration file.

---

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

• pipeline/components/cutprescanregion.py