CFEL - ASG Software Suite  2.5.0
CASS
Public Member Functions | Protected Attributes | Private Types | Private Member Functions | Private Attributes | List of all members
cass::pp311 Class Reference

calculate the autocorrelation of an image More...

#include <autocorrelation.h>

+ Inheritance diagram for cass::pp311:
+ Collaboration diagram for cass::pp311:

Public Member Functions

 pp311 (const name_t &)
 constructor More...
 
virtual void process (const CASSEvent &, result_t &)
 process the event More...
 
virtual void loadSettings (size_t)
 load the settings of this pp More...
 
- Public Member Functions inherited from cass::Processor
 Processor (const name_t &name)
 constructor More...
 
virtual ~Processor ()
 virtual destructor More...
 
virtual void processEvent (const CASSEvent &event)
 process the event More...
 
virtual const result_tresult (const CASSEvent::id_t eventid=0)
 retrieve a result for a given id. More...
 
virtual void releaseEvent (const CASSEvent &event)
 tell the list that the result for event can be overwritten More...
 
result_t::shared_pointer resultCopy (const uint64_t eventid)
 retrieve histogram for id More...
 
virtual void load ()
 load the general settings More...
 
virtual void aboutToQuit ()
 function that will be called when the processor is about to be deleted More...
 
const names_tdependencies ()
 Define all processors keys a processor depends on. More...
 
void clearDependencies ()
 clear the dependenies More...
 
void clearHistograms ()
 clear the histograms More...
 
virtual void processCommand (std::string command)
 process command in pp More...
 
const name_t name () const
 retrieve the name of this processor More...
 
bool hide () const
 retrieve the hide flag of this processor More...
 
const std::string & comment () const
 retrieve the comment of this processor More...
 

Protected Attributes

shared_pointer _hist
 pp containing histogram to calculate the autocorrelation for More...
 
- Protected Attributes inherited from cass::Processor
const name_t _name
 the processors name More...
 
bool _hide
 flag to tell whether this pp should be hidden in the dropdown list More...
 
std::string _comment
 optional comment that one can add to a processor. More...
 
CachedList _resultList
 the list of results More...
 
names_t _dependencies
 the list of dependencies More...
 
shared_pointer _condition
 pointer to the processor that will contain the condition More...
 

Private Types

typedef std::vector< std::pair< int, result_t::value_t > > ring_t
 define a ring that knows its position in the original image and the value at that position More...
 

Private Member Functions

int getCircleLength (const int rad)
 retrieve the length of the ring for a given radius More...
 
void fillRing (const result_t &image, const int rad, const int x0, const int y0, const int nxx, ring_t &ring)
 fill the ring with the pixels that belong to a certain radius around a given center More...
 

Private Attributes

std::pair< int, int > _center
 the used center of the image More...
 
int _maxrad
 the used maximum radius More...
 

Additional Inherited Members

- Public Types inherited from cass::Processor
typedef std::tr1::shared_ptr< Processorshared_pointer
 a shared pointer of this More...
 
typedef std::string name_t
 define the name type More...
 
typedef std::list< name_tnames_t
 define the list of names More...
 
typedef CachedList::item_type result_t
 define the results More...
 
typedef CachedList::item_sp resultsp_t
 define the shared pointer to the result More...
 
- Protected Member Functions inherited from cass::Processor
virtual void createHistList (result_t::shared_pointer result)
 create result list. More...
 
void setupGeneral ()
 general setup of the processor More...
 
bool setupCondition (bool defaultConditionType=true)
 setup the condition. More...
 
shared_pointer setupDependency (const std::string &depVarName, const name_t &name="")
 setup the dependecy. More...
 

Detailed Description

calculate the autocorrelation of an image

details

Available PostProcessors:
"311": calculate the autocorrelation of an image
User definable Parameters:

Processor/%name%/{CenterX|CenterY}

Processor/%name%/{MaximumRadius}

Processor/%name%/{ImageName}
processor name containing the histogram whos autocorrelation should be calculated.

Author
Stephan Kassemeyer
Lutz Foucar

Definition at line 66 of file autocorrelation.h.

Member Typedef Documentation

typedef std::vector<std::pair<int,result_t::value_t> > cass::pp311::ring_t
private

define a ring that knows its position in the original image and the value at that position

Definition at line 86 of file autocorrelation.h.

Constructor & Destructor Documentation

pp311::pp311 ( const name_t name)

constructor

Definition at line 83 of file autocorrelation.cpp.

References loadSettings().

Member Function Documentation

void pp311::fillRing ( const result_t image,
const int  rad,
const int  x0,
const int  y0,
const int  nxx,
ring_t ring 
)
private

fill the ring with the pixels that belong to a certain radius around a given center

Note
the ring that is passed to this function should already contain enough elements as it will not be refilled.
Parameters
imagethe original image
radthe radius for which the ring should be found
x0the center in x
y0the center in y
nxxthe number of columns of the original image
ringthe ring that will contain the result

Definition at line 163 of file autocorrelation.cpp.

References cass::ACQIRIS::x, and cass::ACQIRIS::y.

Referenced by process().

int pp311::getCircleLength ( const int  rad)
private

retrieve the length of the ring for a given radius

Returns
the amount of pixels that belong to the radius
Parameters
radthe radius that one wants to find the pixels for

Definition at line 136 of file autocorrelation.cpp.

References cass::ACQIRIS::x, and cass::ACQIRIS::y.

Referenced by process().

void pp311::loadSettings ( size_t  )
virtual
void pp311::process ( const CASSEvent evt,
result_t result 
)
virtual

Member Data Documentation

std::pair<int,int> cass::pp311::_center
private

the used center of the image

Definition at line 113 of file autocorrelation.h.

Referenced by loadSettings(), and process().

shared_pointer cass::pp311::_hist
protected

pp containing histogram to calculate the autocorrelation for

Definition at line 80 of file autocorrelation.h.

Referenced by loadSettings(), and process().

int cass::pp311::_maxrad
private

the used maximum radius

Definition at line 116 of file autocorrelation.h.

Referenced by loadSettings(), and process().


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