CACTUS (Sept 2010) 
==================

VERSION  
See doc/version.txt

GOAL
CACTus (Computer Aided CME Tracking) automatically detects CMEs in coronagraphic 
images. It is currently available for LASCO and SECCHI/COR2/. 

INSTALLATION
CACTus is integrated in the Solarsoftware Library (SSW). For installation of 
CACTus as a package of SSW, see http://www.lmsal.com/solarsoft/
CACTus uses ffmpeg for the production of movies. It is left to the user to 
install ffmpeg separately and to make sure it is in the path. 
CACTus is currently available for LASCO and SECCHI/COR2. Check if the following 
SSW environmental variables are set to values appropriate for your local system 
(do eg  IDL> print, getenv('LZ_IMG'):
  LZ_IMG (... /soho-archive/lasco/lz)
  QL_IMG (... /soho-archive/lasco/qkl)
  secchi (... secchi-archive)

HELP
At the SSWIDL prompt, type "IDL> cactus_master, /help"
Feedback can be sent to cactus@oma.be

REFERENCES
Main reference = Robbrecht & Berghmans (2004): 	
	http://adsabs.harvard.edu/abs/2004A%26A...425.1097R 
Latest information and real-time detection: 	
	http://sidc.be/cactus/

MAIN DEFAULTS
Default instrument is LASCO, set keyword /secchi if you want application to 
SECCHI data. For LASCO it digests c2 and c3 images simultaneously, for SECCHI  
only COR2 data is used. Set sc to 'a' or 'b' to select the desired spacecraft. 
CACTus uses by default level zero data. 

CACTus creates a directory tree in the directory that you give as maindir, 
e.g. cactus_master, maindir="$HOME/cactus/". If you do not give keyword maindir, 
CACTus will save the output in your $CACTUSDIR directory

To avoid edge effects in time, CACTus now adds one day at both ends of a give date range, 
however the algorithm will only return the CMEs that start in the given date range. 

MAIN KEYWORDS
/secchi		... use SECCHI data instead of LASCO data
sc		... spacecraft A or B
/qkl            ... use quicklook data instead of level zero.
/no_logfile     ... skip log-info on the screen
/no_click_map   ... skip production of the clickable cmemap in the html-page
/movie          ... produce movies (.mov format)
/archive        ... copy the output to the directory set as archive  
/p1             ... only run part 1 of cactus (see code of cactus_master)
                    (most computation time)
/p2             ... only run part 2 of cactus (see code of cactus_master)
                    (where the actual detection occurs as set by paramters)	

DETECTION PARAMETERS
thresh          [default: 0.3 (LASCO and secchi-a), 0.25 (secchi-b)]
	A measure for the intensity threshold in the Hough space. Reasonable values 
	are 0.2 to 0.4, the lower the value, the more CMEs (and noise) you will detect. If 
	you set it too high, weak parts of bright CMEs will not be detected.
factor          [default: 6] 					
	Additional constraint to avoid false detections when noise is high: 
	intensity > factor*sigma. The cactus-catalog version 1 did not use this constraint.          		
width           [default: 5]							
	Minimal width of CMEs that will be reported (in degrees)
maxniterations  [default: 300]						
	Maximum number of iterations that will be performed in the Hough space. This value should be set higher for larger data-sets.


EXAMPLES
IDL>cactus_master, 20070506, 20070510
IDL>cactus_master, 20070506, ndays=5
IDL>cactus_master, 20070506     ==> will only process this day
IDL>cactus_master               ==> will process the last 4 days of data.   
IDL>cactus_master, /secchi, sc="a", 20070820,20070825, thresh=0.3
IDL>cactus_master, 20070820,20070825, maindir="$HOME/CME_catalogue/20070820/" 
IDL>cactus_master, 20070506, ndays=5, width=20
IDL>cactus_master, /secchi, sc="b", 20070301,20070331, /p1
IDL>cactus_master, /secchi, sc="b", 20070301,20070331, /p2

SECCINGS USED TO CREATE THE COR2 CME CATALOG (http://secchi.nrl.navy.mil/cactus/)
IDL>cactus_master, /secchi, sc="a", 20070301,20070331, thresh=0.30,factor=6, maxniterations=600
IDL>cactus_master, /secchi, sc="b", 20070301,20070331, thresh=0.25,factor=5, maxniterations=600