Quick Command Reference to DHE under ArcVIEW

The following list describes briefly the command and parameters available for the detector controller electronics. For a more detailed description on the parameters, please see the complete DHE command list
All the listed commands MUST begin with the prefix DHE. The system is case INSENSITIVE.
Most of the commands are generic,  but some of them are dependent on the hardware and/or detector. In particular the DAC, MEMORY and REGISTER (section 4) will apply or not depending on the configuration (for example, MEMORY will apply to a SDSU, but not to a Palomar controller)
The meaning of the simbology is:
< > : holds a parameter which is necesarry (mandatory)
[ ] : holds a parameter which is optional
|    : separates possible values for an enumerated type.


1.- Initialization

command	description
START | INIT [path]	starts the DHE software and hardware (this may include drivers, uploading files, to the hardware, etc). If a init file is specified, uses that one, if not, uses the default one specified on the config. file
SHUTDOWN, CLOSE	closes the DHE softwatre and hardware

Configuration file

The "main" initialization file for the module is usually called "MOD_DHE.cfg" or MOD_XXX.cfg, where XXX is the name of the actual detector controller (like MOD_SDSU.cfg for a San Diego State University controller, for example)
The file described here is really a "master" config file as it mainly points at more specific config files. The entries may also vary depending on what the actual hardware supports.

[INIT]
file=<path>          /*initialization file for the specific hardware. The format of this file will be dependent on the specific hardware*/
[TP]
tpfile=<path>       /*file specifying TestPoints to be normally loged and/or used in headers, like power supplies, temperatures, etc*/
[DAC]
file=<path>         /*configuration file for the definitions of dacs for biases, offsets, etc*/
[REGS]
file=<path>         /*configuration file for the REGISTERS definitions*/
[HDRINFO]
file=<path>        /*template file for the header information*/
[LOG]
log=<true | false>
file=<path>        /*path for the log file*/
[LASTIMG]     /*READ ONLY: heare the module stores the last patameters when it is closed, so it starts with them the next time*/
directory=<path>
basename=<string>
imnumber=<unit>
...

2.- Observation setup
SET / GET (dhe set / dhe get)
All the following parametrs can be set or read, unless specifically stated.

obs parameters

complete command	alternates "short"	description	example
obs.exptime <uint | float> [[s]]	exposuretime	exposure time in msecs, or secs if specified ([s])	dhe set obs.exptime 22.0 [s]
obs.display <on | off>	displayimage, display_image	real time display on or off	dhe set displayimage off
obs.numreads <uint>	imagestoread	number of images to read in the next sequence	dhe set obs.numreads 2
obs.autowrit <on | off>	write_to_disk, autowrite	writes the images to disk or not	dhe set autowrite off
obs.observer <string>	-	observer field (for image headers)	dhe set obs.observer Burrus
obs.obstype <string>	type	obstype field (for image headers). Only "dark" has real meaning (no shutter)	dhe set obs.obstype dark
obs.roi <xstart><ystart><xlen><ylen>	-	Region Of Interest (subwindow). Coords.  in unbinned units, from lower left corner	dhe set roi 513 513 1024 1024
obs.writeframes <[expo] [reset]>	-	frames to be written (IR ONLY). Normally just <exposed-reset>.	dhe set writeframes reset
obs.dispframes <[expo] [reset]>	-	frames to be displayed (IR ONLY). Normally just <exposd-reset>	dhe set dispframes expo
obs.fowler <uint>	-	number of fowler samples to perform (IR ONLY)	dhe set obs.fowler 16
obs.coadds <uint>	-	number of images to coadd (IR ONLY)	dhe set coadds 10
obs.sur <uint>	-	number of sumple up the ramp images (IR ONLY)	dhe set sur 20
normalize <on | off>	-	normalize or not the fowler and/or coadded data (sum(frames)/numframes)	dhe set normalize on
progress	-	returns the progress of the image/exposure. (READ ONLY)	dhe get progress

image parameters

complete command	alternates "short"	description	example
image.title <string>	imagetitle	image title, to be the "object" field on the headers	dhe set title M51
image.comment <string>	imagecomment	image comment, to appear on the headers	dhe set imagecomment this is a test
image.directory <abs path>	-	directory where image will be stored	dhe set image.directory /home/images/
image.basename <string>	-	basename for image name	dhe set image.basename junk
image.rootname <directory/basename>		complete rootname, which is directrory + basename	dhe set rootname /home/images/junk
image.prefix <string>	imprefix	prefix for basename	dhe set imprefix red_
image.sufix <string>	imsufix	sufix for basename	dhe set imsufix _red
image.imnumber <uint>	imagenumber, number	number for next image, or initial image if a sequence	dhe set imagenumber 22
image.mext <on | off>	multipleextensions, extensions	image will be single or MEF fits file	dhe set extensions off
image.modifiers <key1 val1 ... keyN valN>	-	data sections of image, like prescan, overscan, etc	dhe set modifiers prescans 22 overscan 50

dhe parameters

complete command	alternate "short"	description	example
dhe.binning <xbin><ybin>	-	binning in x and y (OPTICAL ONLY)	dhe set binning 2 3
dhe.artifdata <on | off>	-	artificial (synthetic) or real data	dhe set dhe.artifdata on
dhe.autoshutter <on | off>	-	opens shutter automatically when exposure starts or not (ex, "off" for darks)	dhe set autoshutter on
dhe.autoclear <on | off>	-	fast clearing of the array before the exposure starts or not (ex, "off" for focus)	dhe set autoclear off
dhe.idle <on | off>	idlemode	idle waveforms (clocking) or not	dhe set idle off
dhe.shutter <open | close>	-	opens  or close the shutter manually	dhe set shutter open
dhe.power <on | off>	-	turn on or off the power to the controller.	dhe set power off
dhe.gainspeed <gain><speed>	-	gain and speed of the video chain	dhe set gainspeed 2 4
dhe. readmode <string>	-	readmode. The readmode must be supported by the hardware	dhe set readmode lower_left
dhe.sampling <string>	-	sampling type. It can be single, cds, cds inverse (reset-expo), sur (sample up the ramp) (IR ONLY)	dhe set sampling cds
dhe.timing	timinginfo	information on frame and pixel time (READ ONLY)	dhe get timinginfo
dhe.geometry	-	information on geometry -topology- (x and y size, etc) (READ ONLY)	dhe get geometry
dhe.config	controllerconfig	information on controller configuration (READ ONLY)	dhe get dhe.config
status	-	information  on current status of the controller (READ ONLY)	dhe get status

3.- Observation control

command	description
EXPOSE	starts the exposure sequence
ABORT	aborts all activity (current exposure/readout/sequence). Current image get lost
STOP	stops sequence, but waits for current exposure/readout to finish
PAUSE	pauses exposure, closing the shutter and stoping the exposure count. (OPTICAL ONLY)
RESUME	resumes a paused exposure (OPTICAL ONLY)
RESET <controller | pci>	resets controller or PCI card

4.- Engineering commands

DAC

command	description	example
SET <dacname><float> [-raw]	sets the specified dac to the specified value, in volts or dac units (if "-raw")	dhe dac set BIASPOWER 2.2
GET [<dacname> [-params]] [-list] [-all]	if dac specified, get value or params (if "-params"); if not, get all values ("-all") or just names ("-list")	dhe dac get -list

MEMORY

command	description	example
WRITE <board><memtype><address><value>	writes the memory address on the specified board and memory type	dhe memory write tim X 0x0 0x21
READ <board><memtype><address>	reads the memory address  on the specified board and memory type	dhe memory read tim X 0x0
LOAD <board><file><path>	loads the specified file onto the specified board	dhe memory load tim file /home/test
MANUALCOMMAND <board><s1><s2><s3><s4><s5><command>	sends the specified command with the specified arguments. "none" for empty args	dhe memory manualcommand tim 1 none none none none SRE

REGISTER

command	description	example
SET <regname> <value | {field1 value1}..{filedN valueN}	sets the specified register with the specified value, or each field in that register with the specified value	dhe reg set  OutBufReg {SFENA 0x1}{SFENB 0x0}
GET <regname [-params][-full] |  -list | -all>	if register specified, get the total value, or field by field (if "-params") or all the specification, value and description (if "-full"). If not register specified, get the names list (if "-list") or the list and value for all (if "-all")	dhe reg get -list