cubheadcorr
NAME
cubheadcorr - correct/modify values of the header (associated data)
of the cube (.cub).
SYNOPSIS
cubheadcorr
[ -file_length byte ]
[ -header_length byte ]
[ -format_id spectrum | cube | ID_number ]
[ -version number ]
[ -data_type Ta | frequency_switch | Tmb |Integ_Ta | Integ_Tmb | RawLong | RawFloat | ID_number ]
[ -history_step number ]
[ -history_line number ]
[ -original_scan_number number ]
[ -backup_version version_number ]
[ -composed_scans number ]
[ -project name ]
[ -scd_name file_name ]
[ -scd_line_number number ]
[ -sw_mode total_power | onoff | frequency_switch | Dicke | ID_number ]
[ -observed_mjd MJD ]
[ -observed_start_time in_sec_from_1970.0 ]
[ -observed_stop_time in_sec_from_1970.0 ]
[ -integration_on_time sec ]
[ -integration_off_time sec ]
[ -observer name ]
[ -observer1 name ]
[ -observer2 name ]
[ -observer3 name ]
[ -observer4 name ]
[ -object name ]
[ -coordinates lb | radec | radec-app | ID_number | -coord_sys lb | radec | radec-app | ID_number ]
[ -l angle_value | -on_l angle_value ]
[ -b angle_value | -on_b angle_value ]
[ -ra angle_value | -on_ra angle_value ]
[ -dec angle_value | -on_dec angle_value ]
[ -az angle_value | -on_az angle_value ]
[ -el angle_value | -on_el angle_value ]
[ -off_l angle_value ]
[ -off_b angle_value ]
[ -off_ra angle_value ]
[ -off_dec angle_value ]
[ -orig_x angle_value ]
[ -orig_y angle_value ]
[ -position_angle deg | -grid_pa degree ]
[ -x angle_value | -on_x angle_value ]
[ -y angle_value | -on_y angle_value ]
[ -telescope name | -telescope_name name ]
[ -ap_eff absolute_value ]
[ -mb_eff absolute_value ]
[ -fss_eff absolute_value ]
[ -beamsize angle_value | -hpbw angle_value ]
[ -receiver name | -rx_name name ]
[ -sideband lsb_ssb | lsb_dsb | usb_ssb | usb_dsb | ID_number | -sb_mode lsb_ssb | lsb_dsb | usb_ssb | usb_dsb | ID_number ]
[ -v_lsr km/s ]
[ -v_off km/s ]
[ -rest_freq GHz ]
[ -obs_freq GHz ]
[ -local_freq GHz ]
[ -if_freq GHz ]
[ -local_multiplier_order number ]
[ -T_sys K | -system_temperature Kelvin ]
[ -T_rx K | -receiver_temperature Kelvin ]
[ -data_rms K ]
[ -calibrator_temperature K ]
[ -data_weight value | rms ]
[ -data_scale_factor value | norm ]
[ -backend name | -be_name name ]
[ -backend_channel_number number | -backend_totel_channel number ]
[ -backend_basis_ch number ]
[ -backend_ch_sign 1 | -1 ]
[ -present_data_channel_number number | -data_ch number ]
[ -be_center_ch value ]
[ -be_center_freq MHz ]
[ -be_disp0 MHz ]
[ -be_disp1 MHz/ch ]
[ -be_disp2 MHz/(ch^2) ]
[ -be_disp3 MHz/(ch^3) ]
[ -be_disp4 MHz/(ch^4) ]
[ -be_freq_resolution MHz ]
[ -be_ch_width value ]
[ -be_ch_origin value ]
[ -site_name name ]
[ -atm_temp C | -atmospheric_temperature Centigrade ]
[ -atm_water hPa | -atmospheric_water_pressure hectoPascal ]
[ -atm_press hPa | -atmospheric_pressure hectoPascal ]
[ -optical_depth_at_zenith value | -tau0_at_observation value ]
[ -observation_memo free_memo ]
[ -observation_comment free_comment]
[ -axis_dimension dimension]
[ -axis_order xyz | yzx | zxy ]
[ -x_axis_name name ]
[ -x_axis_size size ]
[ -x_axis_type type_name ]
[ -x_axis_unit unit_name ]
[ -x_axis_projection projection_method ]
[ -x_axis_reference coordinate_reference ]
[ -x_axis_delta grid_interval ]
[ -x_axis_origin position ]
[ -x_axis_pixel_at_origin pixel_position ]
[ -x_axis_rotation angle ]
[ -x_axis_resolution value ]
[ -x_axis_psf function_name ]
[ -x_axis_original_resolution value ]
[ -y_axis_name name ]
[ -y_axis_size size ]
[ -y_axis_type type_name ]
[ -y_axis_unit unit_name ]
[ -y_axis_projection projection_method ]
[ -y_axis_reference coordinate_reference ]
[ -y_axis_delta grid_interval ]
[ -y_axis_origin position ]
[ -y_axis_pixel_at_origin pixel_position ]
[ -y_axis_rotation angle ]
[ -y_axis_resolution value ]
[ -y_axis_psf function_name ]
[ -y_axis_original_resolution value ]
[ -z_axis_name name ]
[ -z_axis_size size ]
[ -z_axis_type type_name ]
[ -z_axis_unit unit_name ]
[ -z_axis_projection projection_method ]
[ -z_axis_reference coordinate_reference ]
[ -z_axis_delta grid_interval ]
[ -z_axis_origin position ]
[ -z_axis_pixel_at_origin pixel_position ]
[ -z_axis_rotation angle ]
[ -z_axis_resolution value ]
[ -z_axis_psf function_name ]
[ -z_axis_original_resolution value ]
[ -data_value_type type_name ]
[ -data_unit unit_name | -data_value_unit unit_name ]
[ -data_scale scale | -data_value_scale scale ]
[ -data_offset physical_value | -data_value_offset offset_for_pixel=0 ]
[ -dummy_value pixel_value | -data_value_dummy pixel_value ]
[ -data_value_max pixel_value ]
[ -data_value_min pixel_value ]
[ -data_value_mean pixel_value ]
[ -data_value_rms pixel_value ]
[ -data_value_noise pixel_value ]
DESCRIPTION
This command changes the associated values in the cube which was store
in .cub file.
The modification is recorded in the history.
FILTER TYPE
.cub | cubheadcorr | .cub
OPTIONS
- -file_length byte
- Total file length of the .scn file in bytes.
If the .scn file is the latest version,
this value should be the same as the result of "ls -l".
- -header_length byte
- Total header length in bytes.
- -format_id spectrum | cube | ID_number
- The basic structure of file. The file of ".sdb" is "spectrum".
- -version number
- The version number of the file.
- -data_type Ta | frequency_switch | Tmb |Integ_Ta | Integ_Tmb | RawLong | RawFloat | ID_number
- The type of the data in physical meaning.
- Ta - in antenna temperature (K)
- frequency_switch - unfolded frequency switch output in antenna temperature
(K)
- Tmb - in mainbeam brightness temperature (K)
- Integ_Ta - in integrated antenna temperature (K km/s)
- Integ_Tmb - in integrated mainbeam brightness temperature (K km/s)
- RawLong - in raw output (total power)
- RawFloat - in raw output (total power) but convert to float formally.
- -history_step number
- The number of the history steps ("end" step is not counted).
- -history_line number
- The number of lines in the history.
- -original_scan_number number
- An original sequencial number of the scans (.scn).
This number should be given by ASTROS, an observation program.
- -backup_version version_number
- The version number for backup, which is valid at using the command "save".
The created backup file will have a name with this number.
- -composed_scans number
- The number of the original scans (.scn). This number should increase
after "integ" process.
- -project name
- Name of the project. Less than or 16 characters.
- -scd_name file_name
- Name of the original .scd file which was used by ASTROS.
Less than or 8 characters.
- -scd_line_number number
- The line number in the .scd file which was used by ASTROS.
- -sw_mode total_power | onoff | frequency_switch | Dicke | ID_number
- Switching mode to obtain the data.
- total_power - total power mode. Direct output of a recevier.
- onoff - after on-off switching.
- freqency_sw - after frequency switching
- Dicke - after Dicke switching
- -observed_mjd MJD
- The observed date in the modified Julian day.
- -observed_start_time in_sec_from_1970.0
- The observation start time for the profile.
The time is given by sec from 1970/1/1
0:0:0 UTC. (The UNIX/Linux standard).
- -observed_stop_time in_sec_from_1970.0
- The observation stop time for the profile.
The time is given by sec from 1970/1/1
0:0:0 UTC. (The UNIX/Linux standard).
- -integration_on_time sec
- Total integration time as the on-position in seconds.
- -integration_off_time sec
- Total integration time as the off-position in seconds.
- -observer name
- The name of primary observer. Less than or 8 charcters.
- -observer1 name
- The name of primary observer. Less than or 8 charcters.
- -observer2 name
- The name of secondary observer. Less than or 8 charcters.
- -observer3 name
- The name of another observer. Less than or 8 charcters.
- -observer4 name
- The name of another observer or data processor. Less than or 8 charcters.
- -object name
- The name of object. Less than or 15 charcters.
- -coordinates lb | radec | radec-app | ID_number | -coord_sys lb | radec | radec-app | ID_number
- The basic coordinate to use. The local xy coordinate is also defined
by referring the coordinate assigned this selection.
- lb - the Galactic coordinate. Some refers as l(II) and b(II).
- radec - the equitorial coordinate at the epoch B1950.0.
The mean poisiton.
- radec-app - the equitorila coordinate
at the present epoch of the observations. The appearent position.
- -l angle_value | -on_l angle_value
- The galactic longitude position of the on point.
If angle_value is given only the number,
the command takes it as in degrees.
- -b angle_value | -on_b angle_value
- The galactic latitude position of the on point.
If angle_value is given only the number,
the command takes it as in degrees.
- -ra angle_value | -on_ra angle_value
- The equitorial longitude (B1950.0) mean positon of the on point.
If angle_value is given only the number,
the command takes it as in degrees.
- -dec angle_value | -on_dec angle_value
- The equitorial latitude (B1950.0) mean positon of the on point.
If angle_value is given only the number,
the command takes it as in degrees.
- -az angle_value | -on_az angle_value
- The azimath positon of the on point.
If angle_value is given only the number,
the command takes it as in degrees.
- -el angle_value | -on_el angle_value
- The elevation positon of the on point.
If angle_value is given only the number,
the command takes it as in degrees.
- -off_l angle_value
- The galacitc longitude positon of the off point.
If angle_value is given only the number,
the command takes it as in degrees.
- -off_b angle_value
- The galacitc latitude positon of the off point.
If angle_value is given only the number,
the command takes it as in degrees.
- -off_ra angle_value
- The equitorial longitude (B1950.0) mean positon of the off point.
If angle_value is given only the number,
the command takes it as in degrees.
- -off_dec angle_value
- The equitorial longitude (B1950.0) mean positon of the off point.
If angle_value is given only the number,
the command takes it as in degrees.
- -orig_x angle_value
- The longitude positon of the origin of the local XY coordinate.
If angle_value is given only the number,
the command takes it as in degrees.
The referring coordinate is assigned by the keyword "-coordinates".
- -orig_y angle_value
- The latitude positon of the origin of the local XY coordinate.
If angle_value is given only the number,
the command takes it as in degrees.
The referring coordinate is assigned by the keyword "-coordinates".
- -position_angle deg | -grid_pa degree
- The positon angle of the local XY coordinate at the origin.
The value is in degree. The value 0 means the X and Y axes are parallel to the
longitude and latitude line of the referring coordinate, respectively.
The value 90 means the Y axis is parallel to the longitude line.
The referring coordinate is assigned by the keyword "-coordinates".
- -x angle_value | -on_x angle_value
- The longitud positon of the on poing in the local XY coordinate.
If angle_value is given only the number,
the command takes it as in degrees.
The referring coordinate is assigned by the keyword "-coordinates".
- -y angle_value | -on_y angle_value
- The latitude positon of the on point in the local XY coordinate.
If angle_value is given only the number,
the command takes it as in degrees.
The referring coordinate is assigned by the keyword "-coordinates".
- -telescope name | -telescope_name name
- The name of telescope used to get the profile. Less than or 8 characters.
- -ap_eff absolute_value
- The appature efficiency of the telescope.
In absorute value between 0.0 and 1.0, not in percent.
- -mb_eff absolute_value
- The main beam efficiency of the telescope.
In absorute value between 0.0 and 1.0, not in percent.
- -fss_eff absolute_value
- The forward scattering and spilover efficiency of the telescope.
In absorute value between 0.0 and 1.0, not in percent.
- -beamsize angle_value | -hpbw angle_value
- The full width at the maximum of the antenna power beam.
If angle_value is given only the number,
the command takes it as in degrees.
- -receiver name | -rx_name name
- The name of receiver used. Less than or 7 characters
- -sideband lsb_ssb | lsb_dsb | usb_ssb | usb_dsb | ID_number | -sb_mode lsb_ssb | lsb_dsb | usb_ssb | usb_dsb | ID_number
- The observation sideband mode and signal sideband.
- lsb_ssb - Signal in LSB and observation made in SSB.
- lsb_dsb - Signal in LSB and observation made in DSB.
- usb_ssb - Signal in USB and observation made in SSB.
- usb_dsb - Signal in USB and observation made in DSB.
- -v_lsr km/s
- The "center velocity" of the profile in km/s respect to the Local
Standerd of the Rest. The "center velocity" means the standerd referring
velocity for the profile. In most cases this should be the same as
that of the main targetting object.
In some cases the actual center of the profile may be different.
- -v_off km/s
- The "center velocity" of the profile in km/s respect to the Local
Standerd of the Rest for the off point.
This is almost meaningless if the data is not taken in frequency switching.
The "center velocity" means the standerd referring
velocity for the profile. In most cases this should be the same as
that of the main targetting object.
In some cases the actual center of the profile may be different.
- -rest_freq GHz
- The rest frequency of the emission/absorption line to observe in GHz.
- -obs_freq GHz
- The observation frequency of the receiver in GHz.
- -local_freq GHz
- The frequency of the local oscilator in GHz.
- -if_freq GHz
- The frequency of the first IF line in GHz.
- -local_multiplier_order number
- The order of the multiplier attached to LO. Doubler is 2 and tripler is 3.
- -T_sys K | -system_temperature Kelvin
- The system noise temperature including the atmospheric extinction
in Kelvin.
- -T_rx K | -receiver_temperature Kelvin
- The receiver noise temperature in Kelvin.
- -data_rms K
- The rms noise level of the profile in Kelvin.
- -calibrator_temperature K
- The brightness temperature of the thermal calibrator.
- -data_weight value | rms
- The weight of the profile. Usually it is caliculated based upon
the value of the rms noise level.
If you give the word "rms" instead of the value, the command
gives new weight value estimated from data rms level stored in the header.
This is used by the command integ and others.
- -data_scale_factor value | norm
- The scaling factor of the data to adjust in Kelvin.
The value should be multiply to the floating value of "profile.data[ch-1]"
to get intensity in K.
If you give the word "norm" instead of the value, the command
scales the data values stored directly
and resets the scaling value to be unity.
- -backend name | -be_name name
- Name of the backend spectrometer. Less than or 8 characters.
- -backend_channel_number number | -backend_totel_channel number
- The total number of channels in the backend used. Less than or 2048.
- -backend_basis_ch number
- After version 3 it is meaningless. It was the same meaning of "-be_center_ch".
- -backend_ch_sign 1 | -1
- Backend channel polarity. Positive means the RF frequency increases
when the backend frequency increases.
Negative means the RF frequency decreases.
- -present_data_channel_number number | -data_ch number
- The number of data channel. Originally it should be the same as
the number of channel in the backend used but may change by processing
such as smooth.
- -be_center_ch value
- The "center channel" of the backend used.
The "center channel" means the standerd referring
channel for the profile to estimate
the relation between channel number and frequency on the spectrometer.
In some cases the "central channel" may be half of the
"-backend_channel_number".
- -be_center_freq MHz
- The "center frequency" of the backend in MHz.
The "center frequency" means the standerd referring
frequency for the profile to estimate
the relation between channel number and frequency on the spectrometer.
In some cases the "central frequency" may be the actual center of
the full span of the profile.
- -be_disp0 MHz
- The 0th order coefficient of the despersion function of the spectrometer.
The unit is MHz.
- -be_disp1 MHz/ch
- The 1st order coefficient of the despersion function of the spectrometer.
The unit is MHz per channel. The channel means present data channel for ver.3
and later data.
- -be_disp2 MHz/(ch^2)
- The 2nd order coefficient of the despersion function of the spectrometer.
The unit is MHz per square-channel
- -be_disp3 MHz/(ch^3)
- The 3rd order coefficient of the despersion function of the spectrometer.
The unit is MHz per cubic-channel
- -be_disp4 MHz/(ch^4)
- The 4th order coefficient of the despersion function of the spectrometer.
The unit is MHz per 4th-powers-of-(channel)
- -be_freq_resolution MHz
- The frequency resolution of the backend in MHz.
This is the original but not for the present effective resolution.
- -be_ch_width value
- The binning width of the original channel. For the ver.3 and later data
this parameter is meaningless.
- -be_ch_origin value
- The binning start position on the original. For the ver.3 and later data
this parameter is meaningless.
- -site_name name
- Name of the observation site location. Less than or 8 characters.
- -atm_temp C | -atmospheric_temperature Centigrade
- The atmospheric temperature in Centigrade
when the observations are done.
- -atm_water hPa | -atmospheric_water_pressure hectoPascal
- The partial pressure of water vaper in mbar or hecto-Pascal
when the obervations are done.
- -atm_press hPa | -atmospheric_pressure hectoPascal
- The atmospheric pressure in mbar or hecto-Pascal
when the observations are done.
- -optical_depth_at_zenith value | -tau0_at_observation value
-
- -observation_memo free_memo
- Free memorundom in ASCII code. Less than or 64 characters.
- -observation_comment free_comment
- Free comment in ASCII code. Less than or 64 characters
- -axis_dimension dimension
- Nominal dimension number of cub. At present this must be 3.
- -axis_order xyz | yzx | zxy
- Axis index order in pixel data part.
The order "xyz" is standard.
- -x_axis_name name
- Axis name for labeling.
At present the following names are supported;
l, b, RA, Dec, az, el, v
- -x_axis_size size
- The number of elements along the x-axis.
- -x_axis_type type_name
- The data type of the axis.
At present the following names are supported;
long, lat, velocity, freq
- -x_axis_unit unit_name
- The unit of the axis.
At present the following names are supported;
pixel, degree, km/s, GHz
- -x_axis_projection projection_method
- Data projection method
At present the following names are supported;
linear, tan, sin, stereo, Mercator, Sinusoid, Parabol, Aitoff, Molweide
- -x_axis_reference coordinate_reference
- The reference name of the data coordinate if required.
At present the following names are supported other than blank;
lb1, lb2, B1950.0, J2000.0, LSR, helio
- -x_axis_delta grid_interval
- The pixel grid interval. The unit is following "-x_axis_unit".
StarStdAngle format is supported, if the unit is deg.
- -x_axis_origin position
- The position of the referred pixel in the axis unit.
- The pixel position of the origin in real space.
The unit is following "-x_axis_unit".
StarStdAngle format is supported, if the unit is deg.
- -x_axis_pixel_at_origin pixel_position
- The address of the referred pixel used as origin. The smallest address stored in the cub file is 0, not 1.
- -x_axis_rotation angle
- The rotation angle of the axis from the axis_name direction.
StarStdAngle format is supported.
- -x_axis_resolution value
- The effective resolutation of the data along the axis.
StarStdAngle format is supported, if the unit is deg.
- -x_axis_psf function_name
- The name of point spread function for data resolution
At present the following names are supported;
gauss, box
- -x_axis_original_resolution value
- The original resolution of the data along the axis.
StarStdAngle format is supported, if the unit is deg.
- -y_axis_..., -z_axis_...
- The same as -x_axis_... but for y-axis and z-axis.
- -data_value_type type_name
- The type name of the data. Less than or 8 charactors.
- Ta* - corrected antenna temperature
- -data_unit unit_name | -data_value_unit unit_name
- The unit of the data. Less than or 8 characters.
- K - Kelvin
- -data_scale scale | -data_value_scale scale
- scaling factor for the data. A for phys_value=A*pixel_value+B.
- -data_offset physical_value | -data_value_offset offset_for_pixel=0
- offset value for the data. B for phys_value=A*pixel_value+B.
- -dummy_value pixel_value | -data_value_dummy pixel_value
- Pixel value for blank pixel.
- -data_value_max pixel_value
- Maximum pixel value for the data.
- -data_value_min pixel_value
- Minimum pixel value for the data.
- -data_value_mean pixel_value
- -data_value_mean pixel_value ]
- Mean pixel value for the data.
- -data_value_rms pixel_value
- Root mean square of the data in pixel value.
- -data_value_noise pixel_value
- RMS noise level of the data in pixel value.
DEFAULTS
- -prm headcorr.prm
SEE ALSO
cubheadls, .cub
BUGS
- No internal check is applied. If you change some value incorrectly,
the following commands may not be read it.
- Negative option should be supported which deneys the asignment in
the .prm file.
HISTORY
- ver.1.0
- 1993/3/3 T.Handa
- ver.3.21
- 1998/4/16 T.Handa
- ver.3.21a
- 2003/1/29 T.Handa
- ver.3.21b
- 2003/8/27 T.Handa
MANUAL VERSION
2003/8/27 T.Handa
Back to the index