model_polarized_image Class Reference

Defines an interface for models that generate polarized image data with a collection of utility functions to compute visibility amplitudes, closure phases, etc. More...

#include "model/model_polarized_image.h"

Inheritance diagram for model_polarized_image:

Collaboration diagram for model_polarized_image:

Public Member Functions
virtual size_t	size () const
	A user-supplied function that returns the number of the parameters the model expects.
void	model_Dterms (std::vector< std::string > station_codes)
	Add D-terms, increases the number of parameters by four times the number of station codes passed. Will fail if a visibility is requested for a station for which the code has not been provided.
bool	modeling_Dterms () const
	Boolean to determine if this is fitting D-terms.
size_t	number_of_Dterms () const
	Number of D-terms (each complex number)
virtual void	generate_model (std::vector< double > parameters)
	A one-time generate function that permits model construction prior to calling the visibility_amplitude, closure_phase, etc. for each datum. Takes a vector of parameters.
virtual void	generate_complex_visibilities ()
	A one-time generate function that will generate the complex visibilities and store them. This must be called after generate_model has been called.
virtual std::vector< std::complex< double > >	crosshand_visibilities (datum_crosshand_visibilities &d, double accuracy)
	Returns a vector of complex visibility corresponding to RR,LL,RL,LR in Jy computed from the image given a datum_crosshand_visibilities_amplitude object, containing all of the accoutrements. While this provides access to the actual data value, the two could be separated if necessary. Also takes an accuracy parameter with the same units as the data, indicating the accuracy with which the model must generate a comparison value. Note that this can be redefined in child classes.
virtual std::complex< double >	visibility (datum_visibility &d, double accuracy)
	Returns complex visibility in Jy computed from the image given a datum_visibility object, containing all of the accoutrements. While this provides access to the actual data value, the two could be separated if necessary. Also takes an accuracy parameter with the same units as the data, indicating the accuracy with which the model must generate a comparison value. Note that this can be redefined in child classes.
virtual double	visibility_amplitude (datum_visibility_amplitude &d, double accuracy)
	Returns visibility ampitudes in Jy computed from the image given a datum_visibility_amplitude object, containing all of the accoutrements. While this provides access to the actual data value, the two could be separated if necessary. Also takes an accuracy parameter with the same units as the data, indicating the accuracy with which the model must generate a comparison value. Note that this can be redefined in child classes.
virtual double	closure_phase (datum_closure_phase &d, double accuracy)
	Returns closure phase in degrees computed from the image given a datum_closure_phase object, containing all of the accoutrements. While this provides access to the actual data value, the two could be separated if necessary. Also takes an accuracy parameter with the same units as the data, indicating the accuracy with which the model must generate a comparison value. Note that this can be redefined in child classes.
virtual double	closure_amplitude (datum_closure_amplitude &d, double accuracy)
	Returns closure amplitude computed from the image given a datum_closure_phase object, containing all of the accoutrements. While this provides access to the actual data value, the two could be separated if necessary. Also takes an accuracy parameter with the same units as the data, indicating the accuracy with which the model must generate a comparison value. Note that this can be redefined in child classes.
virtual double	polarization_fraction (datum_polarization_fraction &d, double accuracy)
	A user-supplied function that returns the closure amplitudes. Takes a datum_polarization_fraction to provide access to the various accoutrements. While this provides access to the actual data value, the two could be separated if necessary. Also takes an accuracy parameter with the same units as the data, indicating the accuracy with which the model must generate a comparison value.
void	output_image (std::string fname, bool rotate=false)
void	get_image (std::vector< std::vector< double > > &alpha, std::vector< std::vector< double > > &beta, std::vector< std::vector< double > > &I) const
	Provides direct access to the constructed image. Sets a 2D grid of angles (alpha, beta) in radians and intensities in Jy per steradian.
void	get_image (std::vector< std::vector< double > > &alpha, std::vector< std::vector< double > > &beta, std::vector< std::vector< double > > &I, std::vector< std::vector< double > > &Q, std::vector< std::vector< double > > &U, std::vector< std::vector< double > > &V) const
	Provides direct access to the constructed image in all Stokes parameters. Sets a 2D grid of angles (alpha, beta) in radians and intensities in Jy per steradian.
void	get_visibilities (std::vector< std::vector< double > > &u, std::vector< std::vector< double > > &v, std::vector< std::vector< std::complex< double > > > &VI) const
	Provides direct access to the complex visibilities. Sets a 2D grid of baselines (u,v) in lambda, and visibilites in Jy.
void	get_visibilities (std::vector< std::vector< double > > &u, std::vector< std::vector< double > > &v, std::vector< std::vector< std::complex< double > > > &RR, std::vector< std::vector< std::complex< double > > > &LL, std::vector< std::vector< std::complex< double > > > &RL, std::vector< std::vector< std::complex< double > > > &LR) const
	Provides direct access to the crosshand complex visibilities. Sets a 2D grid of baselines (u,v) in lambda, and visibilites in Jy.
void	get_visibility_amplitudes (std::vector< std::vector< double > > &u, std::vector< std::vector< double > > &v, std::vector< std::vector< double > > &V) const
	Provides direct access to the visibility amplitudes. Sets a 2D grid of baselines (u,v) in lambda, and visibilites in Jy.
void	use_spline_interp (bool use_spline)
	Provides ability to use bicubic spline interpolator (true) instead of regular bicubic. Code defaults to false.
virtual void	set_mpi_communicator (MPI_Comm comm)
	Defines a set of processors provided to the model for parallel computation via an MPI communicator. Only facilates code parallelization if the model computation is parallelized via MPI.
void	write_model_tag_file (std::string tagfilename="model_image.tag") const
	Write a unique identifying tag for use with the ThemisPy plotting features. This calls the overloaded version with the outstream, which is the only function that need be rewritten in child classes.
virtual void	write_model_tag_file (std::ofstream &tagout) const
	Write a unique identifying tag for use with the ThemisPy plotting features. For most child classes, the default implementation is suffcient. However, should that not be the case, this is the only function that need be rewritten in child classes.
virtual std::string	model_tag () const
	Return a string that contains a unique identifying tag for use with the ThemisPy plotting features. This function SHOULD be defined in subsequent model_image classes with a unique identifier that contains sufficient information about the hyperparameters to uniquely determine the image. By default it writes "UNDEFINED".

Protected Member Functions
void	apply_Dterms (const datum_crosshand_visibilities &d, std::vector< std::complex< double > > &crosshand_vector) const
	Applies the D-terms. Checks if modeling inside and must be called in crosshand_visibilities if redefined by child classes.
void	read_and_strip_Dterm_parameters (std::vector< double > &parameters)
	Reads and remove Dterm parameters from the parameter list. Checks if modeling inside and must be called in crosshand_visibilities if redefined by child classes.

Protected Attributes
MPI_Comm	_comm
bool	_generated_model
	True when a model is generated with generate_model.
bool	_generated_visibilities
	True when model visibilities have been computed.
bool	_use_spline
	True when want to use bicubic spline interpolator.
double	_position_angle
	Position angle of the image, assumed to be the last element of the parameter list passed to generate_model. Assumed to be in radians and defined E of N.
std::vector< double >	_current_parameters
	Last set of parameters passed to generate_image, useful to determine if it is necessary to recompute the model. Useful, e.g., if we are varying only position angle, or if recomputing for a number of different data sets at the same set of parameters.
std::vector< std::vector< double > >	_alpha
	2D grid of horizonal pixel locations in radians, relative to the fiducial direction of the image (i.e., unrotated by the position angle).
std::vector< std::vector< double > >	_beta
	2D grid of vertical pixel locations in radians, relative to the fiducial direction of the image (i.e., unrotated by the position angle).
std::vector< std::vector< double > >	_I
std::vector< std::vector< double > >	_Q
std::vector< std::vector< double > >	_U
std::vector< std::vector< double > >	_V
	2D grid of intensities at pixel locations in Jy/str.
size_t	_size
bool	_modeling_Dterms
std::vector< std::string >	_station_codes
Protected Attributes inherited from model_crosshand_visibilities
MPI_Comm	_comm
Protected Attributes inherited from model_polarization_fraction
MPI_Comm	_comm
Protected Attributes inherited from model_visibility
MPI_Comm	_comm
Protected Attributes inherited from model_visibility_amplitude
MPI_Comm	_comm
Protected Attributes inherited from model_closure_phase
MPI_Comm	_comm
Protected Attributes inherited from model_closure_amplitude
MPI_Comm	_comm

Private Member Functions
virtual void	generate_image (std::vector< double > parameters, std::vector< std::vector< double > > &I, std::vector< std::vector< double > > &alpha, std::vector< std::vector< double > > &beta)
	A user-supplied function that generates and returns rectalinear grid of intensities in Jy/str located at pixels centered on angular positions alpha and beta, both specified in radians and aligned with a fiducial direction. Note that the parameter vector has had the position removed. Note that it will be assumed that alpha and beta are defined as the image appears on the sky, e.g., beta running from S to N and alpha running from E to W.
virtual void	generate_polarized_image (std::vector< double > parameters, std::vector< std::vector< double > > &I, std::vector< std::vector< double > > &Q, std::vector< std::vector< double > > &U, std::vector< std::vector< double > > &V, std::vector< std::vector< double > > &alpha, std::vector< std::vector< double > > &beta)=0
	A user-supplied function that generates and returns rectalinear grid of Stokes parameters in Jy/str located at pixels centered on angular positions alpha and beta, both specified in radians and aligned with a fiducial direction. Note that the parameter vector has had the position removed. Note that it will be assumed that alpha and beta are defined as the image appears on the sky, e.g., beta running from S to N and alpha running from E to W.
void	compute_raw_visibilities ()
	Utility function to numerically computes the complex visibilities from the image data after _alpha, _beta, and _I have been set. Currently pads the intensity array by a factor of 8.
std::vector< std::vector< std::complex< double > > >	fft_2d (const std::vector< std::vector< double > > &I)
	2D FFT utility function based on FFTW
std::vector< std::vector< std::complex< double > > >	fft_shift (const std::vector< std::vector< std::complex< double > > > &V)
	2D shift utility function to center the zero-baseline modes at the center of the array
size_t	get_index_from_station_code (std::string station_code) const
	Quick bisection search to get index into Dterm array for a given station.

Private Attributes
std::vector< std::vector< double > >	_u
	2D grid of horizontal baseline locations in lambda, relative to the fiducial direction of the image (i.e., unrotated by the position angle).
std::vector< std::vector< double > >	_v
	2D grid of vertical baseline locations in lambda, relative to the fiducial direction of the image (i.e., unrotated by the position angle).
std::vector< std::vector< std::complex< double > > >	_VI
std::vector< std::vector< std::complex< double > > >	_VQ
std::vector< std::vector< std::complex< double > > >	_VU
std::vector< std::vector< std::complex< double > > >	_VV
	2D grid of complex visibilities at pixel locations in Jy.
std::valarray< double >	_i2du
	Arrays for defining the 2D interpolator objects.
std::valarray< double >	_i2dv
	Arrays for defining the 2D interpolator objects.
std::valarray< double >	_i2dVI_r
	Arrays for defining the 2D interpolator objects.
std::valarray< double >	_i2dVI_i
	Arrays for defining the 2D interpolator objects.
std::valarray< double >	_i2dVQ_r
	Arrays for defining the 2D interpolator objects.
std::valarray< double >	_i2dVQ_i
	Arrays for defining the 2D interpolator objects.
std::valarray< double >	_i2dVU_r
	Arrays for defining the 2D interpolator objects.
std::valarray< double >	_i2dVU_i
	Arrays for defining the 2D interpolator objects.
std::valarray< double >	_i2dVV_r
	Arrays for defining the 2D interpolator objects.
std::valarray< double >	_i2dVV_i
	Arrays for defining the 2D interpolator objects.
Interpolator2D	_i2D_VIr
Interpolator2D	_i2D_VQr
Interpolator2D	_i2D_VUr
Interpolator2D	_i2D_VVr
	2D interpolator object to estimate real component of the complex visibilities at arbitrary u-v locations. model_polarized_image uses bicubic interpolation.
Interpolator2D	_i2D_VIi
Interpolator2D	_i2D_VQi
Interpolator2D	_i2D_VUi
Interpolator2D	_i2D_VVi
	2D interpolator object to estimate imaginary component of the complex visibilities at arbitrary u-v locations. model_polarized_image uses bicubic interpolation.
std::vector< size_t >	_station_code_index_hash_table
std::vector< std::complex< double > >	_Dterms

Detailed Description

Many EHT models provide primarily polarized images. This class provides both an interface to the inteferometric data models (model_crosshand_visibility, model_visibility, model_visibility_amplitude, model_closure_phase, etc.) and utility functions for computing the appropriate data types. Unless otherwise stated, the quantities are Stokes I.

Because images can be trivially rotated, model_polarized_image interprets the last parameter as the position angle (radians, E of N) and separately implements it removing the need to apply rotations in the generate_image function. Expects that images will be provided as they appear on the sky, e.g., oriented with E on the left and the E-W coordinate increasing rightward.

Because polarization must be calibrated, model_polarized_images have the option to postpend D-terms. To do this, an array of stations must be provided. An additional set of four times the size of the station array will be postpended to the parameters, corresponding to the real and imaginary components of the R-hand and L-hand D-terms for each station are added.

Warning

This class contains multiple purely virtual functions, making it impossible to generate an explicit instantiation. Uses the FFTW library to compute the FFT to generate visibilities.

Todo:

Add the field rotation angle stuff to the model_polarization_fraction hooks, if required.

Member Function Documentation

void output_image	(	std::string	fname,
		bool	rotate = false
	)

Outputs the generated image using the pmap format. If rotate is true it will rotate the image according to the position angle in the parameter list using a bicubic spline. Line 1 gives the limits in x direction (xmin, xmax, Nx) Line 2 gives the limits in y direction (ymin, ymax, Ny) Line 3 is the columns information Then the image is outputted with first two columns being the pixel numbers and then intensity in Jy/pixel

Here is the call graph for this function:

---

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

• model/model_polarized_image.h
• model/model_polarized_image.cpp