Changes between Version 25 and Version 26 of HetProcedures/RA/Shuffle


Ignore:
Timestamp:
Sep 21, 2022 2:07:09 AM (20 months ago)
Author:
sir
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • HetProcedures/RA/Shuffle

    v25 v26  
    4949
    5050The argument passed to "-shargs" will be sent as an argument to the {{{do_shuffle}}} command run by {{{target_setup}}}. The above examples specify to use the GAIA catalog and to find fainter stars by 3 magnitudes, respectively.
     51
     52=== shuffle arguments ===
     53Here is the list of possible shuffle arguments which can be used in {{{target_setup}}} command
     54{{{
     55usage: do_shuffle [-h] [--verbose] [--version] [--epoch EPOCH] [--pmRA PMRA]
     56                  [--pmDEC PMDEC] [--gaia2radius GAIA2RADIUS] [-c CONFIG]
     57                  [--limited_probe_annulus] [--force-gp1 id1]
     58                  [--force-gp2 id2] [--force-wfs1 id1] [--force-wfs2 id2]
     59                  [--localcat LOCALCAT] [--interactive INTERACTIVE]
     60                  [--hpf HPF] [--use_brightness USE_BRIGHTNESS]
     61                  [--fplane_file FPLANE_FILE] [--az [AZ]]
     62                  [--dpatrol_g1min DPATROL_G1MIN]
     63                  [--dpatrol_g1max DPATROL_G1MAX]
     64                  [--dpatrol_g1targ DPATROL_G1TARG]
     65                  [--dpatrol_g2min DPATROL_G2MIN]
     66                  [--dpatrol_g2max DPATROL_G2MAX]
     67                  [--dpatrol_g2targ DPATROL_G2TARG]
     68                  [--dpatrol_w1min DPATROL_W1MIN]
     69                  [--dpatrol_w1max DPATROL_W1MAX]
     70                  [--dpatrol_w1targ DPATROL_W1TARG]
     71                  [--dpatrol_w2min DPATROL_W2MIN]
     72                  [--dpatrol_w2max DPATROL_W2MAX]
     73                  [--dpatrol_w2targ DPATROL_W2TARG] [--catalog CATALOG]
     74                  [--gppickcol GPPICKCOL] [--wfspickcol WFSPICKCOL]
     75                  [--visualize VISUALIZE] [--visualize_ACAM VISUALIZE_ACAM]
     76                  [--visualize_probestars VISUALIZE_PROBESTARS] [--acam ACAM]
     77                  [--fplane FPLANE] [--probes PROBES]
     78                  [--guide1_magadd GUIDE1_MAGADD]
     79                  [--guide1_nstars GUIDE1_NSTARS]
     80                  [--guide1_minsep GUIDE1_MINSEP]
     81                  [--guide1_magmin GUIDE1_MAGMIN]
     82                  [--guide1_magmax GUIDE1_MAGMAX]
     83                  [--guide2_magadd GUIDE2_MAGADD]
     84                  [--guide2_nstars GUIDE2_NSTARS]
     85                  [--guide2_minsep GUIDE2_MINSEP]
     86                  [--guide2_magmin GUIDE2_MAGMIN]
     87                  [--guide2_magmax GUIDE2_MAGMAX] [--wfs1_magadd WFS1_MAGADD]
     88                  [--wfs1_nstars WFS1_NSTARS] [--wfs1_minsep WFS1_MINSEP]
     89                  [--wfs1_magmin WFS1_MAGMIN] [--wfs1_magmax WFS1_MAGMAX]
     90                  [--wfs2_magadd WFS2_MAGADD] [--wfs2_nstars WFS2_NSTARS]
     91                  [--wfs2_minsep WFS2_MINSEP] [--wfs2_magmin WFS2_MAGMIN]
     92                  [--wfs2_magmax WFS2_MAGMAX] [--ifu_magadd IFU_MAGADD]
     93                  [--ifu_nstars IFU_NSTARS] [--ifu_minsep IFU_MINSEP]
     94                  [--ifu_magmin IFU_MAGMIN] [--ifu_magmax IFU_MAGMAX]
     95                  [--acam_magadd ACAM_MAGADD] [--acam_nstars ACAM_NSTARS]
     96                  [--acam_minsep ACAM_MINSEP] [--acam_magmin ACAM_MAGMIN]
     97                  [--acam_magmax ACAM_MAGMAX] [--fplane_magadd FPLANE_MAGADD]
     98                  [--fplane_nstars FPLANE_NSTARS]
     99                  [--fplane_minsep FPLANE_MINSEP]
     100                  [--fplane_magmin FPLANE_MAGMIN]
     101                  [--fplane_magmax FPLANE_MAGMAX]
     102                  [--allprobes_magadd ALLPROBES_MAGADD]
     103                  [--allprobes_nstars ALLPROBES_NSTARS]
     104                  [--allprobes_minsep ALLPROBES_MINSEP]
     105                  [--allprobes_magmin ALLPROBES_MAGMIN]
     106                  [--allprobes_magmax ALLPROBES_MAGMAX]
     107                  [--allcams_magadd ALLCAMS_MAGADD]
     108                  [--allcams_nstars ALLCAMS_NSTARS]
     109                  [--allcams_minsep ALLCAMS_MINSEP]
     110                  [--allcams_magmin ALLCAMS_MAGMIN]
     111                  [--allcams_magmax ALLCAMS_MAGMAX]
     112                  ra dec radius {0,1} ifuslot [x_offset] [y_offset] [target]
     113
     114Shuffle the HETDEX shots
     115
     116positional arguments:
     117  ra                    ra of the target in hours.
     118  dec                   dec of the target in degrees
     119  radius                Search radius (in degrees) for proper guide stars and
     120                        wfs stars.
     121  {0,1}                 Type of track: 0: East 1: West
     122  ifuslot               ifuslot of the target. For example: 075. Note: the
     123                        boresight is 000.
     124  x_offset              Small X offset from center of ifuslot in arcsecs
     125                        (default: 0.0)
     126  y_offset              Small Y offset from center of ifuslot in arcsecs
     127                        (default: 0.0)
     128  target                Name of the target observation (default: Test)
     129
     130optional arguments:
     131  -h, --help            show this help message and exit
     132  --verbose, -v         Increase verbosity, can be called multiple times
     133                        (default: 0)
     134  --version, -V         show program's version number and exit
     135  --epoch EPOCH         Epoch of target coordinates (default: 2000.0)
     136  --pmRA PMRA           Proper motion in right ascension (mas/yr) (default:
     137                        None)
     138  --pmDEC PMDEC         Proper motion in delination (mas/yr) (default: None)
     139  --gaia2radius GAIA2RADIUS
     140                        Search radius for target match to gaia2 in " (default:
     141                        30.0)
     142  -c CONFIG, --config CONFIG
     143                        Name of the configuration file. When parsing the
     144                        command line, the file is loaded into a configuration
     145                        object (default: ./shuffle.cfg)
     146  --limited_probe_annulus
     147                        Use 0.31 deg for inner probe radius (default: 0)
     148  --force-gp1 id1       Force the guide probe 1 to use the star with the given
     149                        id (default: None)
     150  --force-gp2 id2       Force the guide probe 2 to use the star with the given
     151                        id (default: None)
     152  --force-wfs1 id1      Force the wavefront sensor probe 1 to use the star
     153                        with the given id (default: None)
     154  --force-wfs2 id2      Force the wavefront sensor probe 2 to use the star
     155                        with the given id (default: None)
     156  --localcat LOCALCAT   Use a local catalog for star searches (default: None)
     157  --interactive INTERACTIVE
     158                        Use interactive mode for guide star search. (default:
     159                        None)
     160  --hpf HPF             Use hpf additional selection (default: None)
     161  --use_brightness USE_BRIGHTNESS
     162                        Use the brightness of the probe stars as a selection
     163                        criteria. If False, then the distance from the target
     164                        angle is minimizes. (default: None)
     165  --fplane_file FPLANE_FILE
     166                        Fplane file to be used. (default: None)
     167  --az [AZ]             Manual Non-optimal AZ input (default: None)
     168  --dpatrol_g1min DPATROL_G1MIN
     169                        Guide probe minimum patrol angle (default: None)
     170  --dpatrol_g1max DPATROL_G1MAX
     171                        Guide probe maximum patrol angle (default: None)
     172  --dpatrol_g1targ DPATROL_G1TARG
     173                        Guide probe target patrol angle (default: None)
     174  --dpatrol_g2min DPATROL_G2MIN
     175                        Guide probe minimum patrol angle (default: None)
     176  --dpatrol_g2max DPATROL_G2MAX
     177                        Guide probe maximum patrol angle (default: None)
     178  --dpatrol_g2targ DPATROL_G2TARG
     179                        Guide probe target patrol angle (default: None)
     180  --dpatrol_w1min DPATROL_W1MIN
     181                        Wavefront probe minimum patrol angle (default: None)
     182  --dpatrol_w1max DPATROL_W1MAX
     183                        Wavefront probe maximum patrol angle (default: None)
     184  --dpatrol_w1targ DPATROL_W1TARG
     185                        Wavefront probe target patrol angle (default: None)
     186  --dpatrol_w2min DPATROL_W2MIN
     187                        Wavefront probe minimum patrol angle (default: None)
     188  --dpatrol_w2max DPATROL_W2MAX
     189                        Wavefront probe maximum patrol angle (default: None)
     190  --dpatrol_w2targ DPATROL_W2TARG
     191                        Wavefront probe target patrol angle (default: None)
     192  --catalog CATALOG     Star catalog to use, for example: GAIA (default: None)
     193  --gppickcol GPPICKCOL
     194                        Probe filter to be used. For SDSS DR9 1 = u, 2 = g, 3
     195                        = r, 4 = i , 5 = z For USNO A2 2 = B, 3 = R (default:
     196                        None)
     197  --wfspickcol WFSPICKCOL
     198                        Probe filter to be used. For SDSS DR9 1 = u, 2 = g, 3
     199                        = r, 4 = i , 5 = z For USNO A2 2 = B, 3 = R (default:
     200                        None)
     201  --visualize VISUALIZE
     202                        Make visualization for the shot. (default: None)
     203  --visualize_ACAM VISUALIZE_ACAM
     204                        Make visualization for the ACAM. (default: None)
     205  --visualize_probestars VISUALIZE_PROBESTARS
     206                        Make visualization for the probestars. (default: None)
     207  --acam ACAM           Offset angle for ACAM (default: None)
     208  --fplane FPLANE       Offset angle for fplane (default: None)
     209  --probes PROBES       Offset angle for probes (default: None)
     210  --guide1_magadd GUIDE1_MAGADD
     211                        guide1 magadd (default: None)
     212  --guide1_nstars GUIDE1_NSTARS
     213                        guide1 nstars (default: None)
     214  --guide1_minsep GUIDE1_MINSEP
     215                        guide1 minsep (default: None)
     216  --guide1_magmin GUIDE1_MAGMIN
     217                        guide1 magmin (default: None)
     218  --guide1_magmax GUIDE1_MAGMAX
     219                        guide1 magmax (default: None)
     220  --guide2_magadd GUIDE2_MAGADD
     221                        guide2 magadd (default: None)
     222  --guide2_nstars GUIDE2_NSTARS
     223                        guide2 nstars (default: None)
     224  --guide2_minsep GUIDE2_MINSEP
     225                        guide2 minsep (default: None)
     226  --guide2_magmin GUIDE2_MAGMIN
     227                        guide2 magmin (default: None)
     228  --guide2_magmax GUIDE2_MAGMAX
     229                        guide2 magmax (default: None)
     230  --wfs1_magadd WFS1_MAGADD
     231                        wfs1 magadd (default: None)
     232  --wfs1_nstars WFS1_NSTARS
     233                        wfs1 nstars (default: None)
     234  --wfs1_minsep WFS1_MINSEP
     235                        wfs1 minsep (default: None)
     236  --wfs1_magmin WFS1_MAGMIN
     237                        wfs1 magmin (default: None)
     238  --wfs1_magmax WFS1_MAGMAX
     239                        wfs1 magmax (default: None)
     240  --wfs2_magadd WFS2_MAGADD
     241                        wfs2 magadd (default: None)
     242  --wfs2_nstars WFS2_NSTARS
     243                        wfs2 nstars (default: None)
     244  --wfs2_minsep WFS2_MINSEP
     245                        wfs2 minsep (default: None)
     246  --wfs2_magmin WFS2_MAGMIN
     247                        wfs2 magmin (default: None)
     248  --wfs2_magmax WFS2_MAGMAX
     249                        wfs2 magmax (default: None)
     250  --ifu_magadd IFU_MAGADD
     251                        ifu magadd (default: None)
     252  --ifu_nstars IFU_NSTARS
     253                        ifu nstars (default: None)
     254  --ifu_minsep IFU_MINSEP
     255                        ifu minsep (default: None)
     256  --ifu_magmin IFU_MAGMIN
     257                        ifu magmin (default: None)
     258  --ifu_magmax IFU_MAGMAX
     259                        ifu magmax (default: None)
     260  --acam_magadd ACAM_MAGADD
     261                        acam magadd (default: None)
     262  --acam_nstars ACAM_NSTARS
     263                        acam nstars (default: None)
     264  --acam_minsep ACAM_MINSEP
     265                        acam minsep (default: None)
     266  --acam_magmin ACAM_MAGMIN
     267                        acam magmin (default: None)
     268  --acam_magmax ACAM_MAGMAX
     269                        acam magmax (default: None)
     270  --fplane_magadd FPLANE_MAGADD
     271                        fplane magadd (default: None)
     272  --fplane_nstars FPLANE_NSTARS
     273                        fplane nstars (default: None)
     274  --fplane_minsep FPLANE_MINSEP
     275                        fplane minsep (default: None)
     276  --fplane_magmin FPLANE_MAGMIN
     277                        fplane magmin (default: None)
     278  --fplane_magmax FPLANE_MAGMAX
     279                        fplane magmax (default: None)
     280  --allprobes_magadd ALLPROBES_MAGADD
     281                        allprobes magadd (default: None)
     282  --allprobes_nstars ALLPROBES_NSTARS
     283                        allprobes nstars (default: None)
     284  --allprobes_minsep ALLPROBES_MINSEP
     285                        allprobes minsep (default: None)
     286  --allprobes_magmin ALLPROBES_MAGMIN
     287                        allprobes magmin (default: None)
     288  --allprobes_magmax ALLPROBES_MAGMAX
     289                        allprobes magmax (default: None)
     290  --allcams_magadd ALLCAMS_MAGADD
     291                        allcams magadd (default: None)
     292  --allcams_nstars ALLCAMS_NSTARS
     293                        allcams nstars (default: None)
     294  --allcams_minsep ALLCAMS_MINSEP
     295                        allcams minsep (default: None)
     296  --allcams_magmin ALLCAMS_MAGMIN
     297                        allcams magmin (default: None)
     298  --allcams_magmax ALLCAMS_MAGMAX
     299                        allcams magmax (default: None)
     300}}}
    51301
    52302=== shuffle run info ===