STIR  6.2.0
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
stir::ReportMovement Class Reference

A class for reporting the movement within the frame w.r.t. to the reference position. More...

Inheritance diagram for stir::ReportMovement:
Inheritance graph
[legend]

Public Member Functions

 ReportMovement (const char *const par_filename)
 
virtual Succeeded process_data ()
 
- Public Member Functions inherited from stir::TimeFrameMotion
void move_to_reference (const bool)
 
void set_frame_num_to_process (const int)
 
int get_frame_num_to_process () const
 
const RigidObject3DTransformationget_current_rigid_object_transformation () const
 get transformation from (or to) reference for current frame More...
 
const RigidObject3DTransformationget_rigid_object_transformation_to_reference () const
 Get the transformation to the reference as returned by the RigidObject3DMotion object.
 
const TimeFrameDefinitionsget_time_frame_defs () const
 
double get_frame_start_time (unsigned frame_num) const
 
double get_frame_end_time (unsigned frame_num) const
 
const RigidObject3DMotionget_motion () const
 
- Public Member Functions inherited from stir::ParsingObject
 ParsingObject (const ParsingObject &)
 
ParsingObjectoperator= (const ParsingObject &)
 
void ask_parameters ()
 
virtual std::string parameter_info ()
 
bool parse (std::istream &f)
 
bool parse (const char *const filename)
 

Protected Member Functions

virtual void set_defaults ()
 parsing functions
 
virtual void initialise_keymap ()
 Initialise all keywords.
 
virtual bool post_processing ()
 This will be called at the end of the parsing. More...
 
- Protected Member Functions inherited from stir::TimeFrameMotion
void set_defaults () override
 parsing functions
 
void initialise_keymap () override
 Initialise all keywords.
 
bool post_processing () override
 This will be called at the end of the parsing. More...
 
- Protected Member Functions inherited from stir::ParsingObject
virtual void set_key_values ()
 This will be called before parsing or parameter_info is called. More...
 

Protected Attributes

std::vector< CartesianCoordinate3D< float > > reference_points
 
std::string output_filename_prefix
 
- Protected Attributes inherited from stir::ParsingObject
KeyParser parser
 

Detailed Description

A class for reporting the movement within the frame w.r.t. to the reference position.

Example par file
See also
TimeFrameMotion for other parameters
  ReportMovement Parameters:=

  ; parameters from TimeFrameMotion

  reference point 1:={50,0,0}
  reference point 2:={100,0,30}
  reference point 3:={100,0,-30}

  ; next defaults to 'report_movement'
  output filename prefix := somestring
  END :=

Member Function Documentation

◆ post_processing()

bool stir::ReportMovement::post_processing ( )
protectedvirtual

This will be called at the end of the parsing.

Returns
false if everything OK, true if not

Reimplemented from stir::ParsingObject.


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