SWDatabase
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Macros Pages
Classes | Functions | Variables
read_timeserie_ace_maglv4 Namespace Reference

Classes

class  ACEMAGLV4Error
 

Functions

def read
 Master routine for reading ACE/MAG/level4 different formats. More...
 
def read_v0
 Read V0 format and return a module_timeserie.Timeserie object. More...
 
def from_v0_to_v1
 Convert ASCII_ACEMAGLV4_V0 format into ASCII_ACEMAGLV4_V1 format. More...
 

Variables

tuple ref_epoch = datetime.datetime(1996,1,1)
 
tuple ancillary_path = os.path.join(path_ace,'ACE_ANCIL.HDF')
 

Function Documentation

def read_timeserie_ace_maglv4.from_v0_to_v1 (   path_v0,
  path_v1 
)

Convert ASCII_ACEMAGLV4_V0 format into ASCII_ACEMAGLV4_V1 format.

ACE/MAG/Level4 V1-format is the following:
B in Tesla in IAU_SUN frame written with Standard V0 Timeserie ascii format.
Routine for reading such format is ascii_timeserie.read_v0.

Here is the call graph for this function:

def read_timeserie_ace_maglv4.read (   filepath,
  frame = None 
)

Master routine for reading ACE/MAG/level4 different formats.

Parameters
[in]filepathPath of the file
[in]frameFrame name of the output timeserie data. GSE or RTN (default) for V1 file. IAU_SUN (default) for V2 file.

Here is the call graph for this function:

Here is the caller graph for this function:

def read_timeserie_ace_maglv4.read_v0 (   filepath,
  frame = 'RTN' 
)

Read V0 format and return a module_timeserie.Timeserie object.

Returns
module_timeserie.Timeserie() object with B in T in GSE or RTN frame.

ACE/MAG/Level4 V0-format is the following:

1 16-second average Interplanetary Magnetic Field in RTN and GSE Coordinates
2 some header
3 
4 SCclock -------ACE Epoch Time----- ------RTN Coordinates---- ------GSE Coordinates----
5  Mid Start End Br Bt Bn Bx By Bz <|B|> dBrms wt
6 
7 713089914.0 765158390.54 765158406.54 0.041 6.562 -0.322 -0.045 -6.535 -0.671 6.605 0.806 48
8 713089930.0 765158406.54 765158422.54 0.446 6.524 -0.359 -0.449 -6.496 -0.706 6.587 0.854 48
9 713089946.0 765158422.54 765158438.54 0.443 6.288 -0.072 -0.446 -6.275 -0.407 6.344 0.858 48
10 ...

Where Bx,By,Bz is the magnetic field in GSE frame in nano Tesla
And where Br,Bt,Bn is the magnetic field in RTN frame in nano Tesla.

Here is the caller graph for this function:

Variable Documentation

tuple read_timeserie_ace_maglv4.ancillary_path = os.path.join(path_ace,'ACE_ANCIL.HDF')
tuple read_timeserie_ace_maglv4.ref_epoch = datetime.datetime(1996,1,1)