The clupos operator

For rules when using the Cluster CSDS data see the Cluster Science Data System.

The clupos operator reads the CSDS AUX data. Then it needs to read at least 60 sec interval (in ctm).
If you wants to step forward less than 60 sec you can use the Options->step in ctm.

If the menubar is not shown press the M key. Then the menubar should be visible.

Summary of keyboard controls:
keyboard shortcut action
M m toggle menubar on and off
ArrowUp u increase the scaling of the magnetic field
ArrowDown d decrease the scaling of the magnetic field
ArrowRight r increase the scaling of the plasma speed
ArrowLeft l decrease the scaling of the plasma speed
Insert t increase the scaling of the E dusk
Delete q decrease the scaling of the E dusk
Home i shift upper graphics to the left
End j shift upper graphics to the right
PageUp s shift upper graphics upwards
PageDown g shift upper graphics down
H h show this help
focus:
In order for the keyboard control to work, the clupos window must be in focus.
Press the left mouse button when the mouse cursor is inside the clupos window in order to get it in focus.
Also the mouse cursor must be inside the clupos window.

The clupos operator is used to show the position of the Cluster satellites. The position of the satellite is marked with a symbol.

The satellite symbols
SC1 square sc1_image Rumba
SC2 diamond sc2_image Salsa
SC3 circle sc3_image Samba
SC4 triangle sc4_image Tango
See the defintion of Cluster Spacecraft Identifiers

arguments in igr Calculator

The clupos operator has 18 arguments
v0 = clupos(q0,q1,q2,q3,q4,q5,q6,q7,q8,q9,q10,q11,q12,q13,q14,q15,q16,q17) missing quantities
  1. If FGM B_xyz_gse do not exists it can be replaced with something else, e.g. Cluster X efw E p4 10Hz any. In this case no B is plotted.
  2. If EFW E_dusk do not exists it can be replaced with something else, e.g. Cluster X efw E p4 10Hz any In this case no E_dusk is plotted.
  3. If CL AUX gse_gsm do not exists it can be replaced with something else, e.g. Cluster X efw E p4 10Hz any In this case no gse to gsm coordinate transformation is possible.
  4. If CIS V_* do not exists it can be replaced with something else, e.g. Cluster X efw E p4 10Hz any In this case no V is plotted. (The CIS data do not exists on SC2 and CIS HIA do not exists on SC4.)
The clupos window
clupos_win1
The clupos window contains three panels:
The upper left panel shows the positions of the satellites relative to SC3 in the xz-plane (GSE or GSM).
The upper right panel shows the positions of the satellites relative to SC3 in the xy-plane (GSE or GSM).
The scales in the two upper panels are in km.

The bottom panel shows the absolute position of SC3. Here the xy-plane, and xz-plane overlaps.
In the xy-plane the SC3 is showed as a filled (or colored) circle and in the xz-plane the SC3 is an open (or colored) circle.
In the bottom panel the scale is Re (earth radius). The coordinate system is GSE or GSM.
The earth is shown in the middle of the bottom panel.

In the two upper panels the magnetic field vectors from CSDS_PP FGM are shown. This is plotted as black lines.
The arrow up and arrow down on the keyboard are used to set the scale of the magnetic field vectors.

In the two upper panels the plasma speed vectors from CSDS_PP CIS are shown.
The CIS HIA is plotted as blue lines and the CIS V_p (Codif) is plotted as magenta lines.
The arrow left and arrow right on the keyboard are used to set the scale of the plasma speed vectors.

In the right upper panel the Edusk (Ey) from CSDS_PP EFW is shown. This is plotted as a red line.
The Insert and Delete keys on the keyboard are used to set the scale of the Edusk.
clupos_win2

top window border
The clupos top window border shows the UT time and the position in Re of SC3.
scale
shift
Home and End keys shift the upper graphics to the left and to the right respectively. The PageUp and PageDown keys shift the upper graphics up and down. The maximum number of shift in each direction is 15. The shift is written in the menubar as h:H v:V. H is the horizontal shift [-15,+15] in hex. V is the vertical shift [-15,+15] in hex. This text is grey. (The shift is not saved to the configuration file.)
size of window
The size of the window can be changed. The graphics automatically adjust to the size of the clupos window.
Re
The radius of the earth used in this operator is 6371.2 km, (defined in the CSDS User Manual
print & hardcopy
The clupos operator has no printing tool. Then you have to use a window copy program/function in order to copy the graphic drawing to a graphic file. (If you are running Linux and KDE you can use the KSnapshot in order to copy the graphics into a file. Then if you are running X inside Microsoft Windows (C) you can use the alt PrintScreen in order to copy the content of the active window to the clipboard. ) It might then be useful before printing/copy to change the background color of the window to white.

Selecting colors:

Background:
When pressing the Options->Color->Background the user can select background color.
When using the screen capture program a useful background color is white.
Selecting spacecraft colors in the upper panel;
Selecting SC3 color in the lower panel:

Controlling the clupos operator

The clupos control window
clupos_win1 When changing the settings (buttons) in the Clupos Control Window the OK or Update button must be pressed in order to execute the changes. When the Cancel button is pressed the Clupos Control Window disappears.
Plot B
When the Plot B button is selected the magnetic field vector is plotted in the upper panels. The lines for the magnetic field vector are black. When the Plot B button is unselected, no magnetic field vector is plotted.
Plot E
When the Plot E button is selected the electric field E dusk is plotted in the right upper panel. The lines for the E dusk are red. When the Plot E button is unselected, no electric field is plotted.
Plot Vh
When the Plot Vh button is selected the plasma speed vector V_HIA is plotted in the upper panels. The CSDS CIS V_HIA vector is plotted in blue color. When the Plot Vh button is unselected, no plasma speed vector V_HIA is plotted.
Plot Vp
When the Plot V button is selected the plasma speed vector V_p is plotted in the upper panels. The CSDS CIS V_p vector is plotted in violet color. When the Plot Vp button is unselected, no plasma speed vector V_p is plotted.
Panels:
The different panels in the clupos operator graphic window were explained above. When the single button is pressed only the two upper panels are shown. When the double button is pressed the bottom panel is shown. In order to show the info panel info button is pressed. (The info panel and the bottom panel will not appear at the same time.)
Coord System:
(GSM Geocentric Solar Magnetospheric coordinates) (GSE Geocentric Solar Ecliptic coordinates)
The CSDS data read from Isdat are in GSE coordinate system. The "CSDS SP CL AUX gse_gsm" quantity is used (Ψ). Then the
   (Xgsm)    (1    0       0) (Xgse)
   (Ygsm) =  (0 cosΨ   -sinΨ) (Ygse)
   (Zgsm)    (0 sinΨ    cosΨ) (Zgse)
matrix is used to transform from GSE to GSM coordinates, (see CSDS User Manual).
When the GSE coordinate system is used the GSE is written in the left part. When the GSM coordinate system is used the GSM is written in the left part. The clupos operator sets Edusk to zero in the GSM coordinate system. When the GSM button is pressed the position of the satellites, the magnetic field vectors and the plasma speed vectors are transformed to the GSM coordinate system. (The DS and IDS coordinate systems are, in the clupos operator, not yet implemented.)
Overwrite:
When the no button is selected the vectors are erased between each time step (in ctm).
When the yesCMode button is pressed the vectors are not erased between each time step. In this case the magnetic field vector (or plasma speed vector) changes color between each time step.
When yes button is pressed the vectors are erased between each time step.
clupos_cont
When the yesCMode is used it is useful to use the info panel. The info panel is a narrow panel below the two top panels. In the info panel is then shown the UT times of each vector in color. The info panel is shown when the Panels:info button is pressed. Mark: The info window will not show up if the bottom panel is present. (Technical: If a redraw event appears, only the vector corresponding to the last time is redrawn.) When the yesCMode color mode used, and you trigger a redraw event the colored vectors corresponding to other times disappears. (Be careful not to move, resize or cover the clupos window with other windows in this yesCMode color mode.)
The yesMoveSC3 option has the same feature as the yesCMode option. However this time also the spacecraft SC3 moves. This time the absolute movements of the spacecraft are shown, not only relative to SC3.
TextBottom:
In the bottom panel extra text can be shown with the UT time and the positions of all satellites. This utility can be toggled off and on with the TextBottom selection. The positions are given in Re (units of earth radius) when the yes(Re) button is selected, and km when the yes(km) button is selected. When yes(rel) button is selected the position are given in km relative to SC3.
ShowOrbit:
When the yes button is selected the orbit for the whole time interval selected is shown in the bottom panel. The SC3 position at the start time in the interval is shown as a circle. If the GSM coordinate system is selected also the orbit coordinates are transformed to the GSM.
When the yesCont button is selected the orbit is not erased between each new time interval from the ISDAT data base handler.
PrintValues:
When the yes button is selected some values are printed in the xterm window. (The window you started the ctm or igr clients from). If the CoordSystem GSM is selected the values are transformed to the GSM coordinate system.
Scale, MaxScaleX (km), MaxScaleY, MaxScaleZ:
When the Scale auto button is selected the clupos operator automatic compute the scale in the upper panels.
When the manual button is selected the settings in the MaxScaleX, MaxScaleY and MaxScaleZ text lines are used for the upper panels X, Y and Z axis respectively. (These settings are not saved to the configuration file.)
Return Data:
The default is the CSDS_PP C1 FGM B_xyz_gse data is returned from the clupos operator to the main igr. However, when the yes button is pressed some other data is returned in vector format to be plotted in the main igr graphic window. (This is TBD. Now, in version 2.0, only a 3-D line is returned).
LineWidth:
The line with of the drawing can be changed with the LineWidth option button. 1 is giving the thinnest lines and 5 makes the program draw the thickest lines.
TextSize:
The size of the text and the satellites can be changed with the TextSize option button. 1 is the smallest size and 5 is the biggest size.
clupos
This is an example of using the yesMoveSC3 option. In this mode the abolute movements of all the four spacecraft are shown, (not only relative to SC3.) Ten absolute movements are shown, t0, t1, ..., t9. Then the window is erased before the next position (t0) is shown. The first position t0 has SC3 in the centre, and the 9 others are relative to this. The times are shown in the info panel. In this example we have used only t0 and t1. The magnetic field vector (FGM) are shown as black for t0 and red for t1. The times written in the info panel has the same colors.

More information

save configuration:
When in the igr main window the File->Config->Save is used to save the current igr configuration to a config file, most of the settings in the clupos operator are saved. (If you save it as myclupos.igr, use 'more myclupos.igr' to see.)
installing:
The clupos source code installed in $ISDAT_HOME/operators/clupos/ . Then the Imakefile in $ISDAT_HOME/operators/ must be edited. In order to use this operator the $ISDAT_HOME/include/Op.h must be changed with
    #define OpMAX_ARGS 18
It was defined as 10 before. (It has to be minimum 18.)

error:
If nothing is plotted, it usually is because the quantity is missing. The easiset method to check if a quantity is missing, is to use the Info->AllQtys in the main igr menubar. The missing quantities are then printed as: Quantity ..., object does NOT exists: ... (See missing quantities above in this html page.)


Updated Mar 3, 2009 by Bjørn Lybekk