IMP logo

IMP::em::ImageHeader Class Reference


Detailed Description

(Compatible with Xmipp and Spider formats)

Public Types


Public Member Functions

void clear ()
 Clear header data and sets a consistent header.
char * get_date () const
void get_dimensions (float &Zdim, float &Ydim, float &Xdim) const
 Get info about volume dimension from the header.
void get_dimensions (float &Ydim, float &Xdim) const
 Get info about the image dimension from the header.
template<typename T >
void get_euler_angles (T &Phi, T &Theta, T &Psi) const
template<typename T >
void get_euler_angles1 (T &Phi1, T &Theta1, T &Psi1) const
template<typename T >
void get_euler_angles2 (T &Phi2, T &Theta2, T &Psi2) const
float get_fAngle1 () const
 get rotation angle. (Xmipp compatibility)
float get_fAv () const
float get_fFlag () const
 Gets the fFlag.
float get_fFmax () const
float get_fFmin () const
IMP::algebra::Matrix2D< double > get_fGeo_matrix ()
float get_fIangle () const
float get_fIform () const
float get_fIhist () const
float get_fImami () const
float get_fLabbyt () const
float get_fLabrec () const
float get_fLenbyt () const
float get_Flip () const
float get_fNlabel () const
float get_fNrec () const
float get_fSig () const
int get_header_size () const
 get header size
float get_image_type () const
 Get the type of image.
float get_number_of_columns () const
 Get number columns.
float get_number_of_rows () const
 Get number of rows.
float get_number_of_slices () const
 Get number of slices.
float get_object_pixel_size () const
float get_old_rot () const
 get rotation angle. (Xmipp compatibility)
template<typename T >
void get_origin_offsets (T &Zoff, T &Yoff, T &Xoff) const
template<typename T >
void get_origin_offsets (T &Yoff, T &Xoff) const
float get_Phi () const
float get_Phi1 () const
float get_Phi2 () const
float get_Psi () const
float get_Psi1 () const
float get_Psi2 () const
bool get_reversed () const
 Interaction with data.
float get_Scale () const
float get_Theta () const
float get_Theta1 () const
float get_Theta2 () const
char * get_time () const
char * get_title () const
float get_Weight () const
float get_xorigin () const
float get_yorigin () const
float get_zorigin () const
 ImageHeader (float im)
 Constructor. The type of image can be specified.
 ImageHeader (img_type im)
 Constructor. The type of image can be specified.
 ImageHeader ()
 Constructor.
bool is_normalized () const
void print_hard (std::ostream &out) const
 Prints a reduced set of information (debugging purposes).
bool read (std::ifstream &f, bool skip_type_check=false, bool force_reversed=false, bool skip_extra_checkings=false)
 Reads the header of a EM image from an input file stream.
int read (const String filename, bool skip_type_check=false, bool force_reversed=false, bool skip_extra_checkings=false)
 Reads the header of a EM image.
void set_date ()
void set_dimensions (float Zdim, float Ydim, float Xdim)
 Set info about volume dimension in the header.
void set_dimensions (float Ydim, float Xdim)
 Set info about the image dimension in the header.
void set_euler_angles (float Phi, float Theta, float Psi)
void set_euler_angles1 (float Phi1, float Theta1, float Psi1)
void set_euler_angles2 (float Phi2, float Theta2, float Psi2)
void set_fAngle1 (float value)
 set rotation angle. (Xmipp compatibility)
void set_fAv (float value)
void set_fFlag (float value)
 Sets the fFlag.
void set_fFmax (float value)
void set_fFmin (float value)
void set_fIangle (float value)
void set_fIform (float value)
void set_fIhist (float value)
void set_fImami (float value)
void set_fLabbyt (float value)
void set_fLabrec (float value)
void set_fLenbyt (float value)
void set_Flip (float value)
void set_fNlabel (float value)
void set_fNrec (float value)
void set_fSig (float value)
void set_header ()
 Sets a consistent header.
void set_image_type (float im)
 Set the type of image.
void set_image_type (img_type im)
 Set the type of image.
void set_number_of_columns (float n)
 Get number columns.
void set_number_of_rows (float n)
 Set number of rows.
void set_number_of_slices (float n)
 Set number of slices.
void set_object_pixel_size (float value)
void set_old_rot (float value)
 set rotation angle. (Xmipp compatibility)
void set_origin_offsets (float Zoff, float Yoff, float Xoff)
void set_origin_offsets (float Yoff, float Xoff)
void set_Phi (float value)
void set_Phi1 (float value)
void set_Phi2 (float value)
void set_Psi (float value)
void set_Psi1 (float value)
void set_Psi2 (float value)
void set_reversed (bool value)
 Interaction with data.
void set_Scale (float value)
void set_Theta (float value)
void set_Theta1 (float value)
void set_Theta2 (float value)
void set_time ()
void set_title (String newName)
 Set title of image in the header.
void set_Weight (float value)
void set_xorigin (float value)
void set_yorigin (float value)
void set_zorigin (float value)
void show_projection_params (std::ostream &out) const
 Shows only the projection parameters.
void write (std::ofstream &f, bool force_reversed=false)
 Writes the header of a EM image to an output file stream.
void write (const String &filename, bool force_reversed=false)
 Writes the header of a EM image.

Static Public Attributes

 IMG_BYTE = _IMP_em.ImageHeader_IMG_BYTE
 IMG_FOURIER = _IMP_em.ImageHeader_IMG_FOURIER
 IMG_IMPEM = _IMP_em.ImageHeader_IMG_IMPEM
 IMG_INT = _IMP_em.ImageHeader_IMG_INT
 VOL_BYTE = _IMP_em.ImageHeader_VOL_BYTE
 VOL_FOURIER = _IMP_em.ImageHeader_VOL_FOURIER
 VOL_IMPEM = _IMP_em.ImageHeader_VOL_IMPEM
 VOL_INT = _IMP_em.ImageHeader_VOL_INT

Friends

std::ostream & operator<< (std::ostream &out, const ImageHeader &I)
 Output operator.

Member Function Documentation

float IMP::em::ImageHeader::get_fFlag (  )  const

Gets the fFlag.

fFlag contains the number of triads of Euler angles stored in the header (up to three). set_euler_angles2 makes fFlag=2, set_euler_angles1 makes fFlag=max(fFlag, 1), set_euler_angles does not change fFlag

void IMP::em::ImageHeader::set_fFlag ( float  value  ) 

Sets the fFlag.

fFlag contains the number of triads of Euler angles stored in the header (up to three). set_euler_angles2 makes fFlag=2, set_euler_angles1 makes fFlag=max(fFlag, 1), set_euler_angles does not change fFlag

void IMP::em::ImageHeader::set_image_type ( float  im  ) 

Set the type of image.

param[in] im type of image. Available values:

void IMP::em::ImageHeader::set_image_type ( img_type  im  ) 

Set the type of image.

param[in] im type of image. Available values: IMG_BYTE = 0, IMG_IMPEM = 1,IMG_INT = 9, VOL_BYTE = 2, VOL_IMPEM = 3, VOL_INT = 10 , IMG_FOURIER = -1, VOL_FOURIER = -3

Note:
No check is done for correctness of the value Set the type of image


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

Generated on Mon Mar 8 23:09:01 2010 for IMP by doxygen 1.5.8