seidart.routines.arraybuild module

class seidart.routines.arraybuild.Array(channel: str, prjfile: str, receiver_file: str, receiver_indices: bool = False, single_precision: bool = True, is_complex: bool = False, csvfile: str = None, csvfile_c: str = None)

Bases: object

build()

Constructs domain and models based on project file and sets up source and receiver configurations.

getrcx()

Loads the time series data for all receivers and handles complex data conditions.

loadxyz()

Loads and sorts receiver locations from a file and adjusts them according to the domain and CPML layer. If the source_file flag is True, the source file is loaded instead of the receiver file and saved to the object under source_xyz.

Parameters:

source_file (bool) – Flag to indicate if the file is a source file.

save(save_object=True, output_basefile=None)

Save the object as a pickle formatted file and the numpy array of receiver time series to a CSV.

sectionplot(plot_complex: bool = False)

Creates a grayscale section plot of the time series data.

Parameters:

plot_complex (bool) – Plot the complex part of the solution if True.

wiggleplot(receiver_number: int, plot_complex: bool = False, plot_background: str = 'none', plot_vertical=True, figure_size: Tuple[float, float] = (8, 5), **kwargs)

Plot an individual receiver from the list of the receiver files. Use indices in the Python reference frame with the first component being 0.

Parameters:

  • receiver_number (int) – Specify the indice of the reciever from the receiver file to plot.

  • plot_complex (bool) – Plot the complex part of the solution if True.

  • plot_background (str) – Specify the plot background color. Default is transparent.

  • figure_size (Tuple[float, float]) – Specify the figure dimensions in inches. Default is (8,5) width and height, respectively.

  • **kwargs –

    Additional plotting parameters as defined in matplotlib.pyplot.plot.

seidart.routines.arraybuild.main(prjfile: str, receiver_file: str, channel: str, rind: bool, is_complex: bool, single_precision: bool, exaggeration: float, gain: int, plot_complex: bool = False, plot: bool = False) → None

The main function creating an Array object and triggering plotting or saving actions based on user inputs.

Parameters:

  • prjfile (str) – Path to the project file.

  • receiver_file (str) – Path to the receiver file.

  • channel (str) – Data channel to be analyzed.

  • rind (bool) – Flag for coordinate indices.

  • is_complex (bool) – Flag for complex data handling.

  • single_precision (bool) – Flag for single precision data.

  • exaggeration (float) – Aspect ratio between the x and y axes for plotting.

  • gain (int) – Smoothing length for the data.

  • plot_complex (bool) – Flag to plot complex part of the solution.

  • plot (bool) – Flag to enable plotting.