mse_dot Module Reference

Module for opening and reading a 'mse.' file. The file format for these files are documented in Motional Stark Effect Diagnostic Dot File. More...

Functions/Subroutines
subroutine	mse_dot_read (mse_file, signals, signals_created, observed, sigma, weight, first_index)
	Read an motional stark effect diagnostic dot file. More...
subroutine	mse_dot_parse_vec (mse_dot_file_ref, coordinate_type, signals, signals_created, observed, sigma, weight, first_index, in_degrees, is_ratio)
	Parse motional stark effect diagnostic point defined as a vector. More...
subroutine	mse_dot_parse_ang (mse_dot_file_ref, coordinate_type, signals, signals_created, observed, sigma, weight, first_index, in_degrees1, in_degrees2, is_ratio)
	Parse motional stark effect diagnostic point defined as angles. More...

Detailed Description

Module for opening and reading a 'mse.' file. The file format for these files are documented in Motional Stark Effect Diagnostic Dot File.

Function/Subroutine Documentation

mse_dot_parse_ang()

subroutine mse_dot::mse_dot_parse_ang	(	type (signal_dot_file), intent(inout)	mse_dot_file_ref,
		character (len=*), intent(in)	coordinate_type,
		type (signal_pointer), dimension(:), intent(inout)	signals,
		integer, intent(inout)	signals_created,
		real (rprec), dimension(:), intent(in)	observed,
		real (rprec), dimension(:), intent(in)	sigma,
		real (rprec), dimension(:), intent(in)	weight,
		integer, intent(inout)	first_index,
		logical, intent(in)	in_degrees1,
		logical, intent(in)	in_degrees2,
		logical, intent(in)	is_ratio
	)

Parse motional stark effect diagnostic point defined as angles.

Parses a signle point. Points are laid out as,

• chord_name
• Point of measurement as three reals.
• Angles with respect to the toroidal as two reals.
• Angles with respect to the horizontal as two reals.

Parameters

[in]	mse_dot_file_ref	Reference to the mse. file.
[in]	coordinate_type	Specifies the cartesian or cylindrical coordinate type.
[in,out]	signals	Array of pointers to the a signal
[in,out]	signals_created	Number valid signals in the array, or index of the last signal created.
[in]	observed	Array of observed values.
[in]	sigma	Array of observed sigma values
[in]	weight	Array of signal weight values
[in,out]	first_index	Index of the first instance of an mse signal.
[in]	in_degrees1	Angles specified in degrees if true.
[in]	in_degrees2	Signal measures degrees if true.
[in]	is_ratio	Signal measures ratio if true.

Definition at line 503 of file mse_dot.f.

mse_dot_parse_vec()

subroutine mse_dot::mse_dot_parse_vec	(	type (signal_dot_file), intent(inout)	mse_dot_file_ref,
		character (len=*), intent(in)	coordinate_type,
		type (signal_pointer), dimension(:), intent(inout)	signals,
		integer, intent(inout)	signals_created,
		real (rprec), dimension(:), intent(in)	observed,
		real (rprec), dimension(:), intent(in)	sigma,
		real (rprec), dimension(:), intent(in)	weight,
		integer, intent(inout)	first_index,
		logical, intent(in)	in_degrees,
		logical, intent(in)	is_ratio
	)

Parse motional stark effect diagnostic point defined as a vector.

Parses a signle point. Points are laid out as,

• chord_name
• Point of measurement as three reals.
• Starting point of view as three reals.
• Ending point of view as three reals.
• Starting point of beam as three reals.
• Ending point of beam as three reals.

Parameters

[in]	mse_dot_file_ref	Reference to the mse. file.
[in]	coordinate_type	Specifies the cartesian or cylindrical coordinate type.
[in,out]	signals	Array of pointers to the a signal
[in,out]	signals_created	Number valid signals in the array, or index of the last signal created.
[in]	observed	Array of observed values.
[in]	sigma	Array of observed sigma values
[in]	weight	Array of signal weight values
[in,out]	first_index	Index of the first instance of an mse signal.
[in]	in_degrees	Signal measures degrees if true.
[in]	is_ratio	Signal measures ratio if true.

Definition at line 382 of file mse_dot.f.

mse_dot_read()

subroutine mse_dot::mse_dot_read	(	character (len=path_length), intent(in)	mse_file,
		type (signal_pointer), dimension(:), intent(inout)	signals,
		integer, intent(inout)	signals_created,
		real (rprec), dimension(:), intent(in)	observed,
		real (rprec), dimension(:), intent(in)	sigma,
		real (rprec), dimension(:), intent(in)	weight,
		integer, intent(inout)	first_index
	)

Read an motional stark effect diagnostic dot file.

Parses the structure of a dignostic dot file and constructs a mse object. Each point is parsed by mse_dot_parse_point.

Parameters

[in]	mse_file	Name of the mse. file.
[in,out]	signals	Array of pointers to the a signal
[in,out]	signals_created	Number valid signals in the array, or index of the last signal created.
[in]	observed	Array of observed values.
[in]	sigma	Array of observed sigma values
[in]	weight	Array of signal weight values
[in,out]	first_index	Index of the first instance of an intpol signal.

Definition at line 159 of file mse_dot.f.