Mpu Tool.rar | Added By Users
Click Here ->->->-> https://urluso.com/2t8rpN
The MPU backed userspace implementation requires the creation of a secondaryset of stacks. These stacks exist in a 1:1 relationship with each thread stackdefined in the system. The privileged stacks are created as a part of thebuild process.
A post-build script scripts/build/gen_kobject_list.py scans the generatedELF file and finds all of the thread stack objects. A set of privilegedstacks, a lookup table, and a set of helper functions are created and addedto the image.
The niprefilter2 task produces an augmented NICER-specific filterfile. It transforms an existing "Level1" filter file produced byniprefilter and adds additional columns and information to make it a"Level2" file. This additional information is more useful forfiltering and generating background estimates.The input to this task is an existing "Level1" filter file producedby niprefilter, as well as an existing NICER observation directory.The output is a modified "Level2" filter file.The task will make numerous temporary files in the output directory.Users should have adequate free disk space to accomodate a significantnumber of temporary files. The temporary files are deleted during thenormal course of the task, unless cleanup=NO.It is possible to modify the filter file "in place" by specifying thesame names for infile and outfile, or outfile="INFILE". In reality, atemporary copy of a new filter file is created, and then moved intoplace upon successful completion of the task. Thus, if theniprefilter2 operation fails at an intermediate step, the originalfile will not be modified.The NICER team does not recommend to delete the original Level1 filterfile, because it is not possible to run niprefilter2 upon theaugmented Level2 file. Therefore is possible to retain the originalfilter file, with append=YES. This is the default operation. In thiscase niprefilter2 will append the original filter file Level1extension to the output, with extension name ORIG_PREFILTER. At alater point in time, it is possible to run niprefilter2 on thisoutput, and the task will automatically seek to the original Level1extension and ignore the Level2 extension.SELECTING TASK-SPECIFIC COLUMNSIn addition to the "base" or default set of computed columns, userscan select from a few recipes of additional columns. These recipes are usefulfor task-specific work. By default, the task-specific columns are not computed, but users canselect them using the coltypes parameter. The coltypes parameter is acomma-separated list of classes of columns. The default value,"base", indicates to compute the standard default columns (and in factcannot be de-selected). To add more task-specific columns, turn thisinto a comma-separated list. For example, coltypes="base,3c50"would select both the base columns and the "3c50" specific columns. Currently thesupported column types are:base - default columns, cannot be deselected3c50 - NICER background model "3C50" specific columnsSee below for more information about the task-specific column sets.In addition to the column sets listed above, coltypes may also containitems of the form "COLNAME" to ensure that the column "COLNAME" isincluded in the output, or "-COLNAME" to ensure that the column"COLNAME" is excluded from the output. Thus, the expression coltypes="base,-ISS_ATT_STATE,FPM_DEADTIME"would begin with the base set of default columns, but excludeISS_ATT_STATE and be sure to include FPM_DEADTIME.OUTPUT COLUMNSThis is a summary of outputs produced by niprefilter2. Please notethat the first group of columns is produced by niprefilter, and aredocumented here again for completeness (with heading ORIGINAL). Thesecond group of columns is produced by niprefilter2 and have headingNEW.IMPORTANT NOTE: column order may not be preserved in the output.Please do not depend on specific column numbers or orders of columnsin the output file. The columns listed below are not given in exactcolumn order.Definition of "COUNT" ValuesBelow there are various columns with "COUNT" in their names. Theseare the number of events of the designated type, in the standard filter file sample interval (typically 1 second). Since the typicalsample interval is 1 second, these counts are also effectivelyrates.PREFILTER COLUMNS (ORIGINAL)The first columns are produced by the mission-generic task prefilterwhich creates pointing and orbit-related quantities. Col Name Format[Units](Range) Comment 1 TIME 1D [s] seconds since mission epoch 2 POSITION 3E [km] ECI position of satellite [X,Y,Z] 3 VELOCITY 3E [km/s] ECI velocity of satellite [X,Y,Z] 4 QUATERNION 4E attitude quaternion 5 PNTUNIT 3E pointing unit vector 6 POLAR 3E [km, rad, rad] geodetic radius lat lon 7 RA 1E [deg] pointing axis right ascension 8 DEC 1E [deg] pointing axis declination 9 ROLL 1E [deg] pointing axis roll 10 SAT_LAT 1E [deg] sub-satellite point latitude 11 SAT_LON 1E [deg] sub-satellite point longitude 12 SAT_ALT 1E [km] distance from earth center 13 ELV 1E [deg] angle between pointing and earth limb 14 BR_EARTH 1E [deg] angle between pointing and bright earth 15 SUNSHINE 1I 1=in sunshine; 0=not 16 FOV_FLAG 1I 0=sky; 1=dark earth; 2=bright earth 17 SUN_ANGLE 1E [deg] angle between pointing and sun vector 18 MOON_ANGLE 1E [deg] angle between pointing and moon vector 19 RAM_ANGLE 1E [deg] angle between pointing and velocity vector 20 ANG_DIST 1E [deg] angular distance of pointing from nominal 21 SAA 1I 1=in SAA; 0=not 22 SAA_TIME 1E [s] time since entering/exiting SAA 23 COR_ASCA 1E [GeV/c] magnetic cut off rigidity (ASCA map) 24 COR_SAX 1E [GeV/c] magnetic cut off rigidity (IGRF map) 25 MCILWAIN_L 1E McIlwain L parameter (SAX) 26 SUN_RA 1E [deg] RA of sun (equatorial) 27 SUN_DEC 1E [deg] Dec of sun (equatorial) 28 MOON_RA 1E [deg] RA of moon (equatorial) 29 MOON_DEC 1E [deg] Dec of moon (equatorial) 30 EARTH_RA 1E [deg] RA of earth (equatorial) 31 EARTH_DEC 1E [deg] Dec of earth (equatorial) 32 TIME_ADJ 1D [s] adjusted seconds since mission epochThe RA,DEC columns indicate the pointing of NICER's estimated averageboresight (the mean boresight found by averaging over all modules).The ELV column is the elevation of the pointing direction above theearth's limb, while the BR_EARTH column indicates the angle from thebright earth limb. In orbit night, BR_EARTH is 180 degrees.The SUNSHINE flag indicates the presence of orbit data at the locationof NICER (not daylight at the ground track on the earth's surface).The ANG_DIST value indicates the angular separation between thetarget, specified by the 'ranom' and 'decnom' command line parameters,and the actual pointing direction. If ranom=0 and decnom=0, thisquantity will be unreliable.The SAA column indicates if NICER is in the South Atlantic Anomaly(SAA) as defined by prefilter. prefilter has a predefined model ofthe SAA which is mission-generic and not optimized for NICER. SeeNICER_SAA below. The SAA_TIME column indicates time since passagethrough the prefilter SAA boundary.The COR_ASCA and COR_SAX columns indicate the magnetic cut-offrigidity (magnetic field) level. The COR_SAX value is to be trustedto a greater degree, because it is based on the InternationalGeomagnetic Reference Field (magnetic field model) of the earth andNICER's orbit. The COR_ASCA model is based on an early map producedby the ASCA spacecraft and may not be applicable to NICER. TheMCILWAIN_L column is the McIlwain L parameter derived for NICER'sorbit using the IGRF.NICER SAA DEFINITION (ORIGINAL) Name Format[Units](Range) Comment NICER_SAA 1B NICER-specific SAA definitionThe NICER_SAA is a custom definition of SAA for the NICER payload onthe ISS. It is produced from NICER data. The region file for thiscontour is stored in CALDB, but can be specified from the command line(via the saaregfile parameter).MPU HOUSEKEEPING (ORIGINAL)The measurement power unit (MPU) produces individualized housekeepingdata within housekeeping files, originally stored in the obs/xti/hk/subdirectory. These files are specified using the mpuhkfiles commandline parameter. niprefilter2 takes these files and creates vectorcolumns so that all MPU statistics for certain telemetry points areavailable for screening. Name Format[Units](Range) Comment MPU_ALL_COUNT 56I Per-FPM ALL counts MPU_OVER_COUNT 56I Per-FPM OVER counts MPU_UNDER_COUNT 56I Per-FPM UNDER counts MPU_XRAY_COUNT 56I Per-FPM XRAY counts TOT_ALL_COUNT 1J Array total ALL counts TOT_UNDER_COUNT 1J Array total UNDER counts TOT_OVER_COUNT 1J Array total OVER counts TOT_XRAY_COUNT 1J Array total XRAY counts FPM_ON 56L Is FPM enabled for science output? NUM_FPM_ON 1J Number of FPMs enabled for scienceThe MPU_ALL_COUNT, MPU_OVER_COUNT, MPU_UNDER_COUNT and MPU_XRAY_COUNTrepresent count rates that the MPU measures for each module on a 1second basis. The XRAY count represents the counts tagged by theon-board electronics as an X-ray, although it may not be an X-ray ifit is below-threshold noise or background. The OVER and UNDER countsare over-shoot rates (pulse height exceeds maximum value) andunder-shoot rates (detector resets). The ALL counts are the total ofall counts registered by the MPU.These columns are stored as a 2D array within each cell, so that thecounts from each module can be accessed. These arrays are 1-based,meaning they start with 1 instead of 0. Therefore you add 1 to the0-based MPU and FPM values to access the array. For example, toaccess module DET_ID=41, which is MPU slice 4 and FPM channel 1, addone to each value. In this case, use MPU_*_COUNT[5][2], where 5=4+1and 2=1+1.The TOT_ALL_COUNT, TOT_UNDER_COUNT, TOT_OVER_COUNT and TOT_XRAY_COUNTcolumns are array-wide totals of the corresponding individual counts. The FPM_ON column indicates if an individual FPM is enabled forscience. Again, this is a two dimensional array, so MPU4, FPM1 wouldbe accessed as FPM_ON[5][2].The NUM_FPM_ON column has the total number of enabled modules. Themaximum value is 56 (all modules enabled); and the minimum value is 0(all modules disabled).STAR TRACKER COLUMNS (ORIGINAL) Name Format[Units](Range) Comment ST_BBO 1B Star tracker big bright obj flag ST_VALID 1B Star tracker valid flag ST_OBJECTS 1B Star tracker num. objects ST_VIDEO_VDC 1B [V] Star tracker video voltage ST_STARS 1B Star tracker num. stars ST_FAILCODE 1B Star tracker failure codeThe ST_VALID flag indicates if the star tracker camera solution isvalid (1) or not (0). Note that the overall attitude solution in theattitude file incorporates other non-camera information and may bevalid even if the star tracker solution is not valid.The ST_BBO column indicates the presence of a Big Bright Object (BBO)in the star tracker field. The ST_OBJECTS and ST_STARS columnsindicate the number of objects/stars in the star tracker field. If nostars are detected, a failure code ST_FAILCODE indicates thereason. The ST_VIDEO_VDC column can be useful to diagnose star trackerimaging issues.ATTITUDE AND POINTING COLUMNS (ORIGINAL) Name Format[Units](Range) Comment ATT_ANG_AZ 1D [deg] Pointing azimuth angle ATT_ANG_EL 1D [deg] Pointing elevation angle ATT_ERR_AZ 1D [deg] Pointing error in azimuth angle ATT_ERR_EL 1D [deg] Pointing error in elevation angle RA_CMD 1D [deg] Commanded right ascension = J2000 DEC_CMD 1D [deg] Commanded declination = J2000 TARG_CMD 1I Pointing commanded target ID ATT_STATE 1B Pointing control state 1=OPS ATT_MODE 1B Pointing control mode 1=SCIENCE ATT_SUBMODE_AZ 1B Pointing control azimuth track mode 2=TRACK ATT_SUBMODE_EL 1B Pointing control elevation track mode 2=TRACK XTI_PNT_JITTER 1E [arcsec] Instrument 1-second pointing jitter (NICERV3) ANG_DIST_X 1E [arcsec] Target position in instrument X coordinates ANG_DIST_Y 1E [arcsec] Target position in instrument X coordinatesThe ATT_ANG_AZ and ATT_ANG_EL columns represent the gimbal pointingangles in azimuth and elevation, respectively. The ATT_ERR_AZ andATT_ERR_EL columns represent the control error in those valuesrelative to the commanded value. The commanded right and ascensionare reported in the RA_CMD and DEC_CMD columns, as well as thecommanded target in TARG_CMD.The XTI_PNT_JITTER column, added with NICERV3, contains the instrumentpointing jitter with 1-second smoothing constant. The value isexpressed in arcsec. Calculation of this value requires the presenceof the original NICER attitude file. When the target is far out ofthe field of view (more than 90 degrees), or if the attitude file isnot present, a NULL value is stored. Note that access to the NICER mission alignment "teldef" is required (which defaults to CALDB).The ANG_DIST_{X,Y} columns, added with NICERV3, contains the targetcoordinates in instrument boresight coordinates. Note that access to the NICER mission alignment "teldef" is required (which defaults to CALDB).GPS AND TIMING COLUMNS (ORIGINAL) Name Format[Units](Range) Comment PPS_SOURCE 1J Source of time sync 0=SPS,1=GEONS PPS_ERR_LOWPASS 1D [s] Filtered PPS error GPS_INIT 1B GEONS filter state initialized? GPS_CONVERGED 1B GEONS filter state converged?The NICER GPS solution can be used in two fashions. The "raw" GPSsolution, also known as Single Point Solution, and a filteredsolution, also known as GEONS. The PPS_SOURCE column indicates whichsolution is being used for timestamps within the NICER system. ThePPS_ERR_LOWPASS column indicates a measure of how much error is in theGPS solution, measured in seconds. This value is low-pass filtered toaverage several samples.The GPS_INIT and GPS_CONVERGED columns indicate the state of the GEONSGPS filter solution, whether it is intialized and converged,respectively.XRAY RATES (NEW) Name Format[Units](Range) Comment FPM_XRAY_PI_0000_0025 1E X-ray rate 0.000 - 0.250 keV FPM_XRAY_PI_0025_0200 1E X-ray rate 0.250 - 2.000 keV FPM_XRAY_PI_0200_0800 1E X-ray rate 2.000 - 8.000 keV FPM_XRAY_PI_0800_1200 1E X-ray rate 8.000 - 12.000 keV FPM_XRAY_PI_1200_1500 1E X-ray rate 12.000 - 15.000 keV FPM_XRAY_PI_1500_1700 1E X-ray rate 15.000 - 17.000 keV MPU_XRAY_PI_0030_0070 56I X-ray rate 0.3 - 0.7 keV (NICERV4)These are X-ray rates derived from the event files after screening outmost non X-rays. They are different from the housekeeping ratesbecause they are formed directly from the events with additionalscreening and energy cuts. The six columns represent rates in sixenergy bands as described above. They are the average rate perenabled FPM, with no attempt at background subtraction.The MPU_XRAY_PI_0030_0070 column (created with NICERV4 and higher), isthe 0.3-0.7 keV count rate for each FPM individually. This can beused for screening out detectors with an extended noise peak.AUGMENTED RATES (NEW) Name Format[Units](Range) Comment MPU_DOUBLE_COUNT 56J MPU over+under reset count from events MPU_OVERONLY_COUNT 56J MPU over-only reset count from events MPU_UNDERONLY_COUNT 56J MPU under-only reset count from events MEDIAN_UNDERONLY_COUNT 1I Median value of MPU_UNDERONLY_COUNT (added NICERV3) FPM_DOUBLE_COUNT 1E Per-FPM over+under reset count from events FPM_OVERONLY_COUNT 1E Per-FPM over-only reset count from events FPM_UNDERONLY_COUNT 1E Per-FPM under-only reset count from eventsThese are are average non X-ray rates derived from the event files.They are different from the housekeeping rates because the event fileallows additional control in separating different kinds of events.The MPU_* columns are 2-dimensional arrays, representing the rate ineach module for each second.MPU_OVERONLY_COUNT is the rate of overshoot-only resets for eachmodule, derived from the event files. Unlike the housekeeping rate,this rate contains only events with the overshoot only flag set, andthus is a better proxy of background.MPU_UNDERONLY_COUNT is the rate of undershoot-only resets for eachmodule, derived from the event files. This rate should be similar tothe housekeeping rate.The MEDIAN_UNDERONLY_COUNT column (added in NICERV3) is the median number of undershoots, where the median is taken over all 56 detectors,excluding detectors with zero undershoots. The median process mayhelp during data screening since it is less susceptible to outlierscompared to FPM_UNDERONLY_COUNT.MPU_DOUBLE_COUNT are the rate of events with both the overshoot andundershoot flag set (so-called double-shoot events) for each module,derived from the event files. In principleMPU_OVERONLY_COUNT+MPU_DOUBLE_COUNT should be comparable to theMPU_OVER_COUNT rate from pure housekeeping.The FPM_{OVERONLY,UNDERONLY_DOUBLE}_COUNT rates represent the averagecount rate of {over,under,double} counts per enabled FPM. Name Format[Units](Range) Comment FPM_RATIO_REJ_COUNT 1E Total PI_RATIO-rejected count MPU_FT_COUNT 56I MPU forced trigger count from events MPU_NOISE25_COUNT 56I MPU PI noise rate 1.53). These are nominallybackground which would be rejected by the so-called trumpet cutby nicerclean. This is the averagecount rate of ratio-rejected events per enabled FPM.FORCED TRIGGER, NOISE AND DEADTIME DIAGNOSTICS (NEW) Name Format[Units](Range) Comment MPU_FT_PI_AVG 56E [chan] MPU forced trigger PI centroid MPU_FT_PI_ERR 56E [chan] MPU forced trigger PI rms MPU_FT_PI_FAST_AVG 56E [chan] MPU forced trigger PI_FAST centroid MPU_FT_PI_FAST_ERR 56E [chan] MPU forced trigger PI_FAST rms MPU_NOISE25_PI_AVG 56E [chan] MPU noise PI centroid < 0.25 keV MPU_NOISE25_PI_ERR 56E [chan] MPU noise PI rms < 0.25 keV MPU_DEADTIME 7D [s] Per-MPU deadtime FPM_DEADTIME 56E [s] Per-FPM deadtime (added by NICERV3)These columns contain spectral diagnostics for NICER. Each of theseis an 56-element array (8x7), sampled once per second. All columns(except for FPM_DEADTIME) are selected when NICERV2 or NICERV3 are set,but not NICERV4 or higher.MPU_FT_PI_AVG is the centroid of the forced trigger peak of the slow(PI) channel for each module, derived from event files. Forcedtriggers represent a signal-free pulse-height and should be centeredat an energy value of 0.0 eV. Because of the sampling of the PIvariable, the forced trigger of the slow PI channel should be centeredat -0.5. The MPU_FT_PI_ERR is the standard deviation of the measuredforced triggers in that one second sample. If no forced triggers arereceived, both values will be NULL.The MPU_FT_PI_FAST_{AVG,ERR} columns are the same as theMPU_FT_PI_{AVG,ERR} columns described above, for the PI_FAST (fast)channel.MPU_NOISE25_PI_{AVG,ERR} are the centroid and standard deviation ofthe NOISE25 values (X-ray events between 50 and 250 eV).The MPU_DEADTIME is the total recorded dead-time for all events, foreach MPU. It is a seven-element vector, one for each MPU, andcontains the amount of recorded deadtime in seconds for each, for allevent types before any screening. The FPM_DEADTIME column (addedwith NICERV3) records the per-FPM deadtime, also in seconds.AUGMENTED HOUSEKEEPING (NEW) Name Format[Units](Range) Comment MPU_LOWMEM_FIFO_DELTA 7B Per-MPU LOWMEM_FIFO Changes (added NICERV3) MPU_LOWMEM_SCI_DELTA 7B Per-MPU LOWMEM_SCI Changes (added NICERV3) HV_ON 56L Is FPM high voltage on? (added NICERV3) FPM_SLOW_LLD 56E Slow channel LLD setting (added NICERV3)These columns provide additional MPU housekeeping information beyond theoriginal prefilter file. These columns were all added with NICERV3.The MPU_LOWMEM_FIFO_DELTA column provides information about lost dataprocessed by an MPU. It contains the number of increments of theLOWMEM_FIFO counter in the given one second interval. TheMPU_LOWMEM_SCI_DELTA records the number of increments of theLOWMEM_SCI counter. An increment of either of these quantities mayindicate degradation of data (loss of data due to transmission outages, etc).The HV_ON column indicates whether the FPM high voltage bias is enabled ornot. There is one logical vector item for each detetector (56-vector). The voltage threshold for a value of 'T'rue is -115 Volts (typical is-125 volts).The FPM_SLOW_LLD columns provides the slow channel low energythreshold (LLD) value. This value is the housekeeping readback, inVolts, of the on-board LLD setting.ISS INFORMATION (NEW) Name Format[Units](Range) Comment ISS_ATT_STATE 4A ISS attitude state ROBO_STATE 1B ISS robotics stateThese columns capture information about the ISS attitude or pointing,as well as the ISS ROBO (robotics) activity.The International Space Station (ISS), which hosts NICER, nominally"flies" in its orbit. This attitude is known as "+XVV" or "LVLH,"referring to the ISS +X axis being in the same direction as thevelocity vector. However, during some activities, the ISS attitudemay change. Also, reboost maneuvers occur occasionally. Thesechanges may disrupt NICER observations and/or disturb NICER pointingcontrol systems beyond their typical limits. The ISS_ATT_STATErecords some basic information to help reconstruct the ISS stateduring an observation.The ISS_ATT_STATE column provides information about the InternationalSpace Station (ISS) attitude state at each sample interval. Thisbasic information is recorded in the 'issmanfile' file, which isnominally accessed via CALDB. The state information is not 100%complete; only major changes are recorded. In addition, theinformation may not be available immediately in NICER CALDB.Scientific users need to monitor NICER CALDB for updates to get themost recent information.The changes captured in ISS_ATT_STATE are: '+XVV' - nominal ISS attitude state 'RBST' - reboost maneuver 'MNVR' - major maneuver '-XVV' - attitude "-XVV" for most Soyuz dockings '+ZVV' - attitude "+ZVV" for many undockingsAn additional column, ROBO_STATE, captures information about ISS ROBO (robotics) activities that may be occuring around NICER.When ROBO activities occur, the robotic appendages may block theNICER field of view and lead to target occultations. When thiscondition is set, it indicates that obstructions may occurbut not necessarily that obstructions will always occur. Only thisgeneral information is available to warn observers in case of unexpected obstructions.The values captured in ROBO_STATE are: 0 - no documented ROBO obstruction 2 - ROBO known to be near NICER (near ELC-2 worksites); obstructions may, but are not guaranteed, to occururVEHICLE DOCKING INFORMATION (NEW) Name Format[Units](Range) Comment VEHICLE_SOYUZ_DC1 1B Vehicle SOYUZ present at port DC1? VEHICLE_SOYUZ_MRM1 1B Vehicle SOYUZ present at port MRM1? VEHICLE_SOYUZ_MRM2 1B Vehicle SOYUZ present at port MRM2? VEHICLE_SOYUZ_SM 1B Vehicle SOYUZ present at port SM?The NICER background may depend on the configuration of theInternational Space Station (ISS). In particular, the Soyuz supplyvehicles contain a radioactive source which may create additionalbackground for NICER. Soyouz vehicles may dock at variousdocking ports.In order to document the presence of vehicles, and where they are docked,the above columns are created. The columns are named, VEHICLE_{vehicle}_{port}where {vehicle} is the vehicle name (currently just SOYUZ) and {port} is the dockingport at which the vehicle was berthed. A value of 1 indicates the vehicle was berthed, and a value of 0 indicates no vehicle was documented as berthed.At present, the NICER team documents the presence of SOYUZ vehicles at dockingports DC-1 ("DC1"), MRM-1 ("MRM1"), MRM-2 ("MRM2") and SM-Aft ("SM"). However,the vehicle types and docking port locations are subject to change in the future.To retrieve the default information, use vehiclefile="CALDB".ADDITIONAL GEOGRAPHIC REGION EVALUATION (NEW) Name Format[Units](Range) Comment NICER_SAA 1B NICER-specific SAA definition LATLONREG 1B inside lat/lon region? 1=yesUsers may wish to explore the data based on geographic position.bSince this can be difficult, niprefilter2 provides some shorthandcapability for geographic calculations. The result is an additionaluser-designated column which has either 1 or 0 depending on thegeographic filter. Users can specify an alternate NICER_SAA definition,which replaces the existing NICER_SAA column, and also their owncustom region definition for any desired purpose.The contour should be the form of a region file, and on the commandline as saaregfile=filename.reg or latlonregfile=filename.reg. Theregion file should in the format of a standard spatial region file,and specify the contour of good or bad data. The region file shouldspecify longitude in the range SAT_LON=-180 to SAT_LON=+180; this isdone to allow easy filtering of the South Atlantic Anomaly (SAA),which crosses SAT_LON==0.Users can also use standard regions that are located in NICER CALDB.Currently there are two named regions in CALDB:SAACONT - standard NICER contourSAACONTLARGE1 - enlarged NICER contourSpecify a CALDB contour using latlonregfile=CALDB:SAACONT orlatlonregfile=CALDB:SAACONTLARGE1.For saaregfile, the results of the evaluation replace the existingNICER_SAA column created by niprefilter. The results of thelatlonregfile evaluation are placed in a user-designated column. Bydefault, this column will be LATLONREG, but users can set a differentcolumn name with the latlonregcolname parameter.If the sense of the latlonregfile region file should be inverted tokeep good data, then use latlonreginvert=YES. Here are the possibleresults:If latlonreginvert=NO, then points inside the region result in 1 and outside the region result in 0.If latlonreginvert=YES, then points inside the region result in 0 and outside the region result in 1.For example, to select points outside the enlarged SAA region filtering, use the following options: niprefilter2 ... latlonregfile=CALDB:SAACONTLARGE1 latlonreginvert=YES \ latlonregcolname=MYREGUpon completion, the column MYREG will be 1 outside the enlarged SAA and 0 inside the the enlarged SAA.TASK-SPECIFIC: NICER Background Model 3C50This is a set of task-specific columns for use with the NICER "3C50"model. See "SELECTING TASK-SPECIFIC COLUMNS" above to understand how this type of output is selected. The name to use with coltypes is "3c50"When this column type is activated, the following columns are created. Name Format[Units](Range) Comment MPU_TRUMP_SEL_1500_1800 56E NICER Trumpet-selected ct (15-18keV) MPU_RATIO_REJ_300_1800 56E NICER PI_RATIO-rejected ct (3-18keV) MPU_NOISE20_COUNT 56I Per-FPM noise rate in 0.0-0.2 keV bandThe MPU_RATIO_SEL_1500_1800 column represents the number of counts inthe 15-18 keV band which survive the "trumpet" cut (seenicerclean for more information).This is also known in the 3C50 model as the "IBG" term.The MPU_RATIO_REJ_300_1800 column represents the number of counts inthe 3-18 keV band which are rejected by the PI_RATIO > 1.53 cut.This is also known in the 3C50 model as the "HREJ" term.The MPU_NOISE20_COUNT column was added in niprefilter2 version 1.17(March 2021), and is the noise count rate in all 56 detectors inthe 0.0-0.2 keV band, as defined by the 3C50 model. Only enabledif NICERV3 also set.TASK-SPECIFIC: Geomagnetic Columnsniprefilter2 can attach geomagnetic-related columns to a filter file.These quantities can include the so called planetary Kp magneticdisturbance index among other quantities.Adding these columns to a filter file requires access to external datawith these values. niprefilter2 does not provide direct access tosuch data, but it does facilitate access to existing data stores.Going into too much detail about this topic is beyond the scopeof the niprefilter2 help file. To find out more on this topic,please consult the NICER Geomagnetic Quantitiesweb page.A recommended way to run niprefilter2 to obtain usefulgeomagnetic quantities is, geomag_path=/your/geomag_path \ geomag_columns="kp_noaa.fits(KP),solarphi_oulu.fits(SOLAR_PHI),COR_NYM"The final column, COR_NYM, is derived with the cornymmiktask, is an adjusted cut-off rigidity value which responds to differentgeomagnetic conditions. As input, KP is required to be present in orderto run cornymmik.When using the above settings, the following columns result. Name Format[Units](Range) Comment KP 1E Potsdam planetary Kp index SOLAR_PHI 1E [GV] Solar modulation potential COR_NYM 1E [GeV/c] Adjusted COR (Nymmik et al)PARAMETERSindir [string]Name of NICER observation directory. The directory must bearranged as a typical NICER observation directory with auxil/,xti/event_uf and xti/event_cl directories.infile [filename]Name of input "Level1" filter file produced by niprefilter.outfile [filename]Name of output filter file, or "INFILE". A new file named outfile willbe created with the contents of the filter file described above.(append="YES") [boolean]If YES, then the original Level1 filter file extension will be appendedto the output.(saaregfile="CALDB") [string]The name of the NICER South Atlantic Anomaly (SAA) region file, whichwill be used to replace the existint NICER_SAA column. Use "CALDB" toquery CALDB. Use "NONE" to keep the existing value unchanged.(vehiclefile="CALDB") [string]Retrieve International Space Station vehicle docking information as afunction of time. If set to "NONE" then this is disabled. If set to"CALDB" or "CALDB:vehiclename", then use CALDB information for the specifiedvehicle (default is "SOYUZ").(issmanfile="CALDB") [string]Retrieve International Space Station maneuver information as afunction of time. If set to "NONE" then this is disabled. If set to"CALDB" then use CALDB information.(robofile="CALDB") [string]Retrieve robotic "robo" activity information as afunction of time. If set to "NONE" then this is disabled. If set to"CALDB" then use CALDB information.(alignfile="CALDB") [string]Retrieve NICER boresight alignment calibration file. If set to"NONE" then columns that require boresight information is disabled.If set to "CALDB" then use CALDB information.(latlonregfile="NONE") [string]Calculate an additional geographic region value as described above. Use"NONE" to skip this step, or "CALDB:name" to query CALDB for region named"name".(latlonregcolname="LATLONREG") [string]Column name to use for geographic region value.(latlonreginvert=NO) [boolean]If YES, then invert the sense of the region computation.(geomag_columns="NONE") [string]Name of files containing geomagnetic quantities. More thanone file can be specified using a comma-separated list. Foreach file on the list, the geomag_path is prepended. Usethe notation "filename(COLNAME)" to specify that the outputcolumn should be named COLNAME. A value of NONE means no extrageomagnetic quantities.(geomag_path="DEFAULT") [string]Name of the base path for all geomagnetic files. Thispath is prepended to each item in the geomag_columns list.If DEFAULT, then the task default of geomagterp is used.(geomag_tcheck="YES") [boolean]If set, then perform rigorous time checking when interpolating geomagnetic quantities. When "NO" thenno checking is performed and stale geomagnetic tablesare allowed.(coltypes="base") [string]A comma-separated list of column types or column names to beincluded using (COLNAME) or excluded (using -COLNAME) as describedabove. The default "base" columns cannot be deselected even if notlisted. See above for the allowed values.(cleanup="YES") [boolean]If yes, then clean up temporary files. If no, temporary files remain. This is typically for debugging.(clobber = NO) [boolean]If the output file already exists, then setting "clobber = yes" will cause it to be overwritten.(chatter = 1) [integer, 0 - 5]Controls the amount of informative text written to standard output.Setting chatter = 4 or higher will produce detailed diagnostic output; chatter = 1 prints out a basic diagnostic message. The default is to produce a brief summary on output.(history = YES) [boolean]If history = YES, then a set of HISTORY keywords will be written tothe header of the specified HDU in the output file to record the valueof all the niprefilter2 task parameters that were used to produce the outputfile.EXAMPLESThis is a typical invocation. It is assumed the user is processingobservation 1234567890, which is stored in directory ./1234567890/ niprefilter2 indir=./1234567890 infile=./1234567890/auxil/ni1234567890.mkf \ outfile=./1234567890/auxil/ni1234567890.mkf clobber=YESIn this case, the output file is called 1234567890/auxil/ni1234567890.mkf2. Theclobber=YES parameter means that the output file can beoverwritten. The original PREFILTER extension will be preserved inthe output file as the second extension, and the new "enhanced"extension will be placed as the first extension.SEE ALSOniprefilter 2b1af7f3a8