TiRiFiC logo

Parameter Index

We provide an alphabetic list of all TiRiFiC parameters on this page. Please click on the links for more information.

Contents:

Parameter index

Name Category Unit Description
ACTION I/O (optional)   Specify reaction on present logfile.
AZkP Geometrical (default 0) degrees Central positions of modelled azimuthal range (k = 1, 2)
AZkP_i Geometrical (default 0) degrees Central positions of modelled azimuthal range (k = 1, 2), ith disk, i = 2, 3, ...
AZkW Geometrical (default 0) degrees Width of modelled azimuthal range (k = 1, 2)
AZkW_i Geometrical (default 0) degrees Width of modelled azimuthal range (k = 1, 2), ith disk, i = 2, 3, ...
BIGTABLE I/O (no default)   Name of output table listing geometrical parameters per sub-ring
BIGTILT I/O (optional)   Name of output fits file, containing a tiltogram per sub-ring.
BMAJ Geometrical (from FITS header) arcsec Observational beam HPBW, major axis
BMIN Geometrical (from FITS header) arcsec Observational beam HPBW, minor axis
BOX I/O (obsolete)   Parameter must be set in GIPSY versions, because of GIPSY, but leave always empty
Name Category Unit Description
BPA Geometrical (from FITS header) degrees Position angle of observational beam major axis, measured anticlockwise from N
CALLITE Fitting (required)   Maximum number of model calculations per iteration (FITMODE 2 only)
CFLUX Geometrical (required) Jy km s-1 Point source (total) flux of first disk
CFLUX_i Geometrical (required) Jy km s-1 Point source (total) flux of ith disk
CLNR Geometrical (default 1)   Number of sub-clouds per cloud
CLNR_i Geometrical (default 1) Number of sub-clouds per cloud, ith disk, i = 2, 3, ...
CONDISP Geometrical (no default) km s-1 Global velocity dispersion
COOLBEAM I/O (default 10) arcsec FWHM of a convolving function to smooth the spatial 3D model as specified with COOLGAL (default: 10 arcsec)
COOLBIN I/O (default 1)   Number of voxels along each axis per input voxel for spatial 3D model as specified with COOLGAL (default: 1)
COOLGAL I/O (optional)   Name of output fits file, containing a spatial 3D realisation of the output model.
DEFFILE I/O (not required)   Name of default file
DELEND Fitting (default variable) Defined with VARY Stepwidth for MODERATE=th and later fitting loop
Name Category Unit Description
DELSTART Fitting (default variable) Defined with VARY= Start stepwidth for first fitting loop
DISTANCE I/O (default 10) Mpc Distance of object, only needed for output (default: 10 Mpc)
DVRA Geometrical (default 0) km s-1 arcsec-1 Vertical gradient of radial velocity
DVRA_i Geometrical (default 0) km s-1 arcsec-1 Vertical gradient of radial velocity, ith disk, i = 2, 3, ...
DVRO Geometrical (default 0) km s-1 arcsec-1 Vertical gradient of rotation velocity
DVRO_i Geometrical (default 0) km s-1 arcsec-1 Vertical gradient of rotation velocity, ith disk, i = 2, 3, ...
DVVE Geometrical (default 0) km s-1 arcsec-1 Vertical gradient of vertical velocity
DVVE_i Geometrical (default 0) km s-1 arcsec-1 Vertical gradient of vertical velocity, ith disk, i = 2, 3, ...
FITMODE Fitting (required)   Fitting mode, 1: Golden Section, old fashion, 2: Golden Section, 3: Simplex
GAkA Geometrical (default 0) Jy km s-1 arcsec-2 Amplitude of kth Gaussian surface-brightness distortion (k = 1, ..., 4)
Name Category Unit Description
GAkA_i Geometrical (default 0) Jy km s-1 arcsec-2 Amplitude of kth Gaussian surface-brightness distortion (k = 1, ..., 4), ith disk, i = 2, 3, ...
GAkD Geometrical (default 0) arcsec Dispersion of kth Gaussian surface-brightness distortion (k = 1, ..., 4)
GAkD_i Geometrical (default 0) arcsec Dispersion of kth Gaussian surface-brightness distortion (k = 1, ..., 4), ith disk, i = 2, 3, ...
GAkP Geometrical (default 0) degrees Phase of kth Gaussian surface-brightness distortion (k = 1, ..., 4)
GAkP_i Geometrical (default 0) degrees Phase of kth Gaussian surface-brightness distortion (k = 1, ..., 4), ith disk, i = 2, 3, ...
GR_COAD_i_j I/O (optional)   Pgplot color of jth additonal data series, ith plot
GR_COL_i I/O (default 0)   Pgplot color of main data series (1-15)
GR_CONT I/O (optional)   Continue after plot (any value)?
GR_DEVICE I/O (optional)   pgplot device for parameter plot
GR_EBAD_i_j I/O (optional) ordinate units Errors for data points, jth additional series, ith plot
Name Category Unit Description
GR_ERAD_i_j I/O (optional)   Plot error bars for data points, jth additional data series, ith plot? (1: yes, 0: no)
GR_ERRB_i I/O (default 0)   Plot error bars for main data series?
GR_ERRV_i I/O (default 1) ordinate units List error bars for main data series
GR_HLCA_i I/O (optional)   Pgplot colors of horizontal lines ith plot
GR_HLVA_i I/O (optional) ordinate units Positions of horizontal lines for ith plot
GR_HORL_i I/O (optional)   Number of horizontal lines to plot for ith plot
GR_INTERPAD_i_j= I/O (defaults to INTY)   Interpolation scheme for lines jth additional series ith plot; 0: linear, 1: natural cubic spline, 2: natural Akima
GR_INTER_i= I/O (defaults to INTY)   Interpolation scheme for lines for main data series; 0: linear, 1: natural cubic spline, 2: natural Akima
GR_LGND I/O (optional)   Plot legend with axis descriptors? (1: yes 0: no)
GR_LIAD_i_j I/O (optional)   Lines between jth additional series ith plot? (1: yes, 0: no)
GR_LINES_i I/O (default 0)   Plot lines for main data series? (1: yes, 0: no)
GR_ML I/O (optional) TXHT= Margin between plot and left hand axis descriptors (in units of TXHT=)
Name Category Unit Description
GR_MR I/O (optional) TXHT= Margin between plot and right hand axis descriptors (in units of TXHT=)
GR_NPAD_i_j I/O (optional)   Number of data points of jth additional series of ith plot
GR_NRAD_i I/O (default 0)   Number of series to add for ith plot
GR_PARMS I/O (optional)   Parameters to plot, first parameter on abscissa
GR_PRFR I/O (optional)   Reference ring for central position
GR_PRFX I/O (optional) deg Right ascension of reference position
GR_PRFY I/O (optional) deg Declination of reference position
GR_SBHT I/O (optional) TXHT= Symbol height (in units of TXHT=)
GR_SBRP I/O (optional)   Plot subrings? (1: yes 0: no)
GR_SIAD_i_j I/O (optional) TXHT= Size of pgplot symbols, jth additional data series, ith plot
Name Category Unit Description
GR_SIZE_i I/O (default 1) TXHT= Size of symbols for main data series
GR_SYAD_i_j I/O (optional)   Pgplot symbol of data points, jth additional series, ith plot
GR_SYMB_i I/O (default -1)   Pgplot symbol used for main data series ith plot
GR_TXHT I/O (optional)   Text height in pgplot units (1/40th of the plot height)
GR_VERL_i I/O (default 0)   Number of vertical lines to plot for ith plot
GR_VLCA_i I/O (optional)   Pgplot colors of vertical lines ith plot (1-15)
GR_VLVA_i I/O (optional) abscissa units Positions of vertical lines for ith plot
GR_XLOG I/O (optional)   Format abscissa logarithmically? (1: yes 0: no)
GR_XMAX I/O (optional) abscissa units Axis range: maximum of abscissa
GR_XMIN I/O (optional) abscissa units Axis range: minimum of abscissa
Name Category Unit Description
GR_XPAD_i_j I/O (optional) abscissa units Values of data points, jth additional data series, ith plot, abscissa
GR_YLOG_i I/O (default 0)   Format abscissa of ith plot logarithmically? (1: yes 0: no)
GR_YMAX_i I/O (optional) ordinate units Axis range: maximum of ordinate, ith plot
GR_YMIN_i I/O (optional) ordinate units Axis range: minimum of ordinate, ith plot
GR_YPAD_i_j I/O (optional) ordinate units Values of data points, jth additional data series, ith plot, ordinate
INCL Geometrical (default 0) degrees Inclination
INCLINO I/O (optional)   Name of output fits file, containing an inclinogram data cube. Only for first disk.
INCL_i Geometrical (default 0) degrees Inclination, ith disk, i = 2, 3, ...
INDINTY Fitting (default 1)   Interpolation scheme between parameters indexed by VARINDX
INIMODE Generic (required)   FFT initialisation mode, integer from 0-3, 3: slowest initialisation, 0: fastest initialisation
INSET I/O   The name of the input data set
Name Category Unit Description
INTY Geometrical (default 0)   Interpolation scheme for sub-grid (sub-ring) parameters; 0: linear, 1: natural cubic spline, 2: natural Akima
IN_REFINE I/O (default 1)   Increase of TILT= in spatial resolution compared to input data cube (default: 1)
ISEED Jy km s-1 arcsec-2 Constant surface brightness
ITEEND Fitting (default variable)   Maximum number of model generations for MODERATE=th and later fitting loop (only FITMODE= 1)
ITESTART Fitting (default variable)   Maximum number of model generations for first fitting loop (only FITMODE= 1)
ITOU I/O (default 1.248683·1024) atoms cm-2 (Jy km s-1 arcsec-2)-1 Conversion from Jy km s-1 arcsec-2 to (HI-) atoms cm-2
LC0 Geometrical (default 0) arcsec Shift along the projected major axis
LC0_i Geometrical (default 0) arcsec Shift along the projected major axis, ith disk, i = 2, 3, ...
LOGNAME I/O (optional)   Name of logfile.
LOOPS Fitting (required)   (Maximum) number of repeated major fitting loops
LS0 Geometrical (default 0) arcsec Shift along the projected minor axis
Name Category Unit Description
LS0_i Geometrical (default 0) arcsec Shift along the projected minor axis, ith disk, i = 2, 3, ...
LTYPE Geometrical (default 0) Vertical density distribution: 0: constant, 1: Gaussian, 2: sech2, 3: exponential, 4: Lorentzian
LTYPE_i Geometrical (default 0) Vertical density distribution: 0: constant, 1: Gaussian, 2: sech2, 3: exponential, 4: Lorentzian, ith disk, i = 2, 3, ...
MAXITER Fitting (required)   Maximum number of iterations for the complete fitting process
MINDELTA Fitting (default variable) Defined with VARY= Fitting grid normalisation (minimal stepwidth)
MODERATE Fitting (default variable)   Loops to interpolate between fit parameters
NCORES Generic (required)   Number of computing cores
NDISKS Geometrical   Number of disks
NUR Geometrical (required)   Number of grid nodes (ring radii)
OUTCUBUP I/O (required)   Frequency of updating OUTSET=
Name Category Unit Description
OUTSET I/O (required)   Name of output data cube
PA Geometrical (default 0) degrees Inclination
PARMAX Fitting (default variable) Defined with VARY= Fitting constraint: maxima
PARMIN Fitting (default variable) Defined with VARY= Fitting constraint: maxima
PA_i Geometrical (default 0) degrees Inclination, ith disk, i = 2, 3, ...
PENALTY Fitting (required)   Penalize outliers from the data cube (continuous parameter, 0: do not penalise)
PROMPT I/O (not required)   Prompt on error (1: yes, 0: no)?
PSW_PSSE Fitting (default 42)   PSWARM seed
PSW_PSNP Fitting (default 42)   PSWARM number of particles
PSW_PSCO Fitting (default 0.5)   PSWARM cognition parameter
PSW_PSSO Fitting (default 0.5)   PSWARM social parameter
PSW_PSMV Fitting (default 0.5)   PSWARM maximum velocity
PSW_PSNF Fitting (default 8000)   PSWARM number of function evaluations to go from initial weight to final weight
PSW_PSII Fitting (default 0.9)   PSWARM initial weight
PSW_PSFI Fitting (default 0.4)   PSWARM final weight
PSW_PSID Fitting (default 2.0)   PSWARM increase delta
PSW_PSDD Fitting (default 0.5)   PSWARM decrease delta
RADI Geometrical (required) arcsec List of grid nodes (ring radii)
RADSEP Geometrical (required) pixel Separation of sub-grids (sub-rings)
RADSEP_i Geometrical (required) pixel Separation of sub-grids (sub-rings), ith disk, i = 2, 3, ...
RAkA Geometrical (default 0) km s-1 Amplitude of harmonic radial velocity kth order (k = 1, ..., 4), first disk
Name Category Unit Description
RAkA_i Geometrical (default 0) km s-1 Amplitude of harmonic radial velocity kth order (k = 1, ..., 4), ith disk, i = 2, 3, ...
RAkP Geometrical (default 0) degrees Phase of harmonic radial velocity kth order (k = 1, ..., 4), first disk
RAkP_i Geometrical (default 0) degrees Phase of harmonic radial velocity kth order (k = 1, ..., 4), ith disk, i = 2, 3, ...
REFRING I/O (default 5)   Number of the reference node to calculate several intrinsic parameters (e.g. warp angle). Default: 5 or NUR= if NUR < 5
REGAMPD Fitting (optional)   Optionally absolute value of denominator in harmonic regularisation
REGAMPL Fitting (optional)   Constant penalty in harmonic regularisation
REGASTE Fitting (optional)   Proportionality constant with loop number for additional penalty in harmonic regularisation
REGDENO Fitting (optional)   Give comma-separated list of denominator orders for (harmonic) regularisation
REGNUME Fitting (optional)   Give comma-separated list of numerator orders for (harmonic) regularisation
REGPARA Fitting (required)   Give comma-separated list of parameters foreseen for (harmonic) regularisation
Name Category Unit Description
REGTHRE Fitting (optional)   Threshold value above which a ratio of harmonic amplitides gets penalised
REGWIDT Fitting (optional)   whidth for the harmonic ratio until maximum penalty is reached
RESTARTNAME Fitting (optional)   Give file name for restarting TiRiFiC
RESTARTID Fitting (optional)   Give ID for restarting tirific
RMS Fitting (required) map units (Jy km s-1) RMS noise in input data cube
ROkA Geometrical (default 0) km s-1 Amplitude of harmonic tangential (rotation) velocity kth order (k = 1, ..., 4), first disk
ROkA_i Geometrical (default 0) km s-1 Amplitude of harmonic tangential (rotation) velocity kth order (k = 1, ..., 4), ith disk, i = 2, 3, ...
ROkP Geometrical (default 0) degrees Phase of harmonic tangential (rotation) kth order (k = 1, ..., 4), first disk
ROkP_i Geometrical (default 0) degrees Phase of harmonic tangential (rotation) kth order (k = 1, ..., 4), ith disk, i = 2, 3, ...
SATDELT Fitting (default variable) Defined with VARY= Define stopping condition after a loop (only FITMODE= 1)
SBR Geometrical (default 1803)   Seed for random-number generator
Name Category Unit Description
SBR_i Geometrical (default 0) Jy km s-1 arcsec-2 Constant surface brightness, ith disk, i = 2, 3, ...
SDIS Geometrical (default 0) km s-1 Radially dependent velocity dispersion
SDIS_i Geometrical (default 0) km s-1 Radially dependent velocity dispersion, ith disk, i = 2, 3, ...
SIZE Fitting (required)   Stopping size of the minimisation process (one number, in units of MINDELTA=)
SMkA Geometrical (default 0) Jy km s-1 arcsec-2 Amplitude of harmonic surface-brightness distortion kth order (k = 1, ..., 4)
SMkA_i Geometrical (default 0) Jy km s-1 arcsec-2 Amplitude of harmonic surface-brightness distortion kth order (k = 1, ..., 4), ith disk, i = 2, 3, ...
SMkP Geometrical (default 0) degrees Phase of harmonic surface-brightness distortion kth order (k = 1, ..., 4)
SMkP_i Geometrical (default 0) degrees Phase of harmonic surface-brightness distortion kth order (k = 1, ..., 4), ith disk, i = 2, 3, ...
TABLE I/O (optional)   Name of output table listing geometrical parameters per node
TILT I/O (optional)   Name of output fits file, containing a tiltogram per ring.
Name Category Unit Description
TIRACC I/O (default 5)   Numerical accuracy for the output .def files TIRDEF= and TIRSMO= (default: 5)
TIRDEF I/O (optional)   Name of output TiRiFiC .def file for repeated fitting runs
TIRLEN I/O (default 3)   Length of Hanning filter used for TIRSMO= (default: 5)
TIRNR I/O (optional)   Number of rings in the output .def files TIRDEF= and TIRSMO=
TIRRAD I/O (optional) arcsec Radii of nodes in the output .def files TIRDEF= and TIRSMO=
TIRSMO I/O (optional)   Hanning-filtered version of TIRDEF=
VARINDX Fitting (required)   List of radial nodes to be ignored for a given parameter name
VARY Fitting (required)   Specification of fitting parameters
VM0A Geometrical (default 0) km s-1 Amplitude of harmonics in LOS velocity 0th order: constant shift in velocity
VM0A_i Geometrical (default 0) km s-1 Amplitude of harmonics in LOS velocity 0th order: constant shift in velocity
Name Category Unit Description
VMkA Geometrical (default 0) km s-1 Amplitude of harmonics in LOS velocity kth order (k = 1, ..., 4)
VMkA_i Geometrical (default 0) km s-1 Amplitude of harmonics in LOS velocity kth order (k = 1, ..., 4)
VMkP Geometrical (default 0) degrees Phase of harmonics in LOS velocity kth order (k = 1, ..., 4)
VMkP_i Geometrical (default 0) degrees Phase of harmonics in LOS velocity kth order (k = 1, ..., 4)
VRAD Geometrical (default 0) km s-1 Mid-plane radial velocity (outwards positive)
VRAD_i Geometrical (default 0) km s-1 Mid-plane radial velocity (outwards positive), ith disk, i = 2, 3, ...
VROT Geometrical (default 0) km s-1 Mid-plane Rotation velocity
VROT_i Geometrical (default 0) km s-1 Mid-plane Rotation velocity, ith disk, i = 2, 3, ...
VSYS Geometrical (default 0) km s-1 Recession velocity
VSYS_i Geometrical (default 0) km s-1 Recession velocity, ith disk, i = 2, 3, ...
Name Category Unit Description
VVER Geometrical (default 0) km s-1 Mid-plane vertical velocity
VVER_i Geometrical (default 0) km s-1 Mid-plane vertical velocity, ith disk, i = 2, 3, ...
WEIGHT Fitting (required)   Continuous parameter to take quantisation noise into account in χ2 evaluation.
WM0A Geometrical (default 0) arcsec Amplitude of harmonic vertical displacement 0th order: constant vertical displacement
WM0A_i Geometrical (default 0) arcsec Amplitude of harmonic vertical displacement 0th order: constant vertical displacement, ith disk, i = 2, 3, ...
WMkA Geometrical (default 0) arcsec Amplitude of harmonic vertical displacement kth order (k = 1, ..., 4)
WMkA_i Geometrical (default 0) arcsec Amplitude of harmonic vertical displacement kth order (k = 1, ..., 4), ith disk, i = 2, 3, ...
WMkP Geometrical (default 0) degrees Phase of harmonic vertical displacement kth order (k = 1, ..., 4)
WMkP_i Geometrical (default 0) degrees Phase of harmonic vertical displacement kth order (k = 1, ..., 4), ith disk, i = 2, 3, ...
XPOS Geometrical (default 0) degrees Right ascension
Name Category Unit Description
XPOS_i Geometrical (default 0) degrees Right ascension, ith disk, i = 2, 3, ...
YPOS Geometrical (default 0) degrees declination
YPOS_i Geometrical (default 0) degrees Declination, ith disk, i = 2, 3, ...
Z0 Geometrical (default 0) arcsec Thickness of disk
Z0_i Geometrical (default 0) arcsec Thickness of disk, ith disk, i = 2, 3, ...
ZDRA Geometrical (default 0) arcsec Vertical gradient of radial velocity
ZDRA_i Geometrical (default 0) arcsec Vertical gradient of radial velocity, ith disk, i = 2, 3, ...
ZDRO Geometrical (default 0) arcsec Vertical gradient of rotation velocity
ZDRO_i Geometrical (default 0) arcsec Vertical gradient of rotation velocity, ith disk, i = 2, 3, ...
ZDVE Geometrical (default 0) arcsec Vertical gradient of vertical velocity
Name Category Unit Description
ZDVE_i Geometrical (default 0) arcsec Vertical gradient of vertical velocity, ith disk, i = 2, 3, ...

Unsupported parameters for GIPSY

We provide old TiRiFiC versions that still depend on GIPSY. This concerns TiRiFiC until version 2.1.5. Here we list keywords that are only supported for version 2.2.0 and higher.

Name Category Unit Description
COOLBIN I/O (default 1)   Number of voxels along each axis per input voxel for spatial 3D model as specified with COOLGAL (default: 1)
DEFFILE I/O (not required)   Name of default file
INDINTY Fitting (default 1)   Interpolation scheme between parameters indexed by VARINDX
GR_INTERPAD_i_j= I/O (defaults to INTY)   Interpolation scheme for lines jth additional series ith plot; 0: linear, 1: natural cubic spline, 2: natural Akima
GR_INTER_i= I/O (defaults to INTY)   Interpolation scheme for lines for main data series; 0: linear, 1: natural cubic spline, 2: natural Akima
INTY Geometrical (default 0)   Interpolation scheme for sub-grid (sub-ring) parameters; 0: linear, 1: natural cubic spline, 2: natural Akima
PROMPT I/O (not required)   Prompt on error (1: yes, 0: no)?
RESTARTNAME Fitting (optional)   Give file name for restarting TiRiFiC
RESTARTID Fitting (optional)   Give ID for restarting tirific