Difference between revisions of "BCU task-centric program list"
Jump to navigation
Jump to search
m (General task-centric program list moved to BCU task-centric program list: Better fitted to contents) |
|||
Line 1: | Line 1: | ||
− | + | List of Basic Cube Utilities (BCU) in Madagascar. Operations listed here can throw away data or fill in with zeros, but should not create new values or alter existing ones -- those belong to the [[NM task-centric program program_list | Numerical Methods program list]]. | |
− | |||
− | |||
− | |||
'''All program names below should be prefixed with "sf".''' | '''All program names below should be prefixed with "sf".''' | ||
Line 32: | Line 29: | ||
== Operation on file content == | == Operation on file content == | ||
− | |||
− | |||
− | |||
− | |||
* Window a portion of the dataset: [[Guide_to_madagascar_programs#sfwindow | window guide]], [http://reproducibility.org/RSF/sfwindow.html window] | * Window a portion of the dataset: [[Guide_to_madagascar_programs#sfwindow | window guide]], [http://reproducibility.org/RSF/sfwindow.html window] | ||
− | |||
− | |||
* Transpose two axes in a dataset: [[Guide_to_madagascar_programs#sftransp | transp guide]], [http://reproducibility.org/RSF/sftransp.html transp] | * Transpose two axes in a dataset: [[Guide_to_madagascar_programs#sftransp | transp guide]], [http://reproducibility.org/RSF/sftransp.html transp] | ||
* Concatenate datasets: [[Guide_to_madagascar_programs#sfcat | cat guide]], [http://reproducibility.org/RSF/sfcat.html cat] or [[Guide_to_madagascar_programs#sfmerge | merge guide]], [http://reproducibility.org/RSF/sfcat.html merge] | * Concatenate datasets: [[Guide_to_madagascar_programs#sfcat | cat guide]], [http://reproducibility.org/RSF/sfcat.html cat] or [[Guide_to_madagascar_programs#sfmerge | merge guide]], [http://reproducibility.org/RSF/sfcat.html merge] | ||
Line 45: | Line 36: | ||
* Extract imaginary part of a complex dataset: [http://reproducibility.org/RSF/sfreal.html imag] | * Extract imaginary part of a complex dataset: [http://reproducibility.org/RSF/sfreal.html imag] | ||
* Create a complex dataset from its real and imaginary parts: [[Guide_to_madagascar_programs#sfcomplex | complex guide]], [http://reproducibility.org/RSF/sfcmplx.html cmplx] | * Create a complex dataset from its real and imaginary parts: [[Guide_to_madagascar_programs#sfcomplex | complex guide]], [http://reproducibility.org/RSF/sfcmplx.html cmplx] | ||
− | |||
* Rotate a portion of one or more axes in the data hypercube: [[Guide_to_madagascar_programs#sfrotate | rotate guide]], [http://reproducibility.org/RSF/sfrotate.html rotate] | * Rotate a portion of one or more axes in the data hypercube: [[Guide_to_madagascar_programs#sfrotate | rotate guide]], [http://reproducibility.org/RSF/sfrotate.html rotate] | ||
* Zero a portion of the dataset: [[Guide_to_madagascar_programs#sfcut | cut guide]], [http://reproducibility.org/RSF/sfcut.html cut] | * Zero a portion of the dataset: [[Guide_to_madagascar_programs#sfcut | cut guide]], [http://reproducibility.org/RSF/sfcut.html cut] | ||
Line 51: | Line 41: | ||
* Combine several datasets by interleaving: [[Guide_to_madagascar_programs#sfinterleave | interleave guide]], [http://reproducibility.org/RSF/sfinterleave.html interleave] | * Combine several datasets by interleaving: [[Guide_to_madagascar_programs#sfinterleave | interleave guide]], [http://reproducibility.org/RSF/sfinterleave.html interleave] | ||
* Pad and interleave traces: [http://reproducibility.org/RSF/sflpad.html lpad] | * Pad and interleave traces: [http://reproducibility.org/RSF/sflpad.html lpad] | ||
− | * | + | * Compute Ni+1 x Ni+2 x ...: [http://reproducibility.org/RSF/sfleftsize.html leftsize] |
* Reverse one or more axes in the data hypercube: [[Guide_to_madagascar_programs#sfreverse | reverse guide]], [http://reproducibility.org/RSF/sfreverse.html reverse] | * Reverse one or more axes in the data hypercube: [[Guide_to_madagascar_programs#sfreverse | reverse guide]], [http://reproducibility.org/RSF/sfreverse.html reverse] | ||
− | |||
==Header operations== | ==Header operations== | ||
Line 64: | Line 53: | ||
* Sort a dataset according to a header key: [[Guide_to_madagascar_programs#sfheadersort | headersort guide]], [http://reproducibility.org/RSF/sfheadersort.html headersort] | * Sort a dataset according to a header key: [[Guide_to_madagascar_programs#sfheadersort | headersort guide]], [http://reproducibility.org/RSF/sfheadersort.html headersort] | ||
* Window a dataset based on a header mask: [[Guide_to_madagascar_programs#sfheaderwindow | headerwindow guide]], [http://reproducibility.org/RSF/sfheaderwindow.html headerwindow] | * Window a dataset based on a header mask: [[Guide_to_madagascar_programs#sfheaderwindow | headerwindow guide]], [http://reproducibility.org/RSF/sfheaderwindow.html headerwindow] | ||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
= Graph, plots, displays = | = Graph, plots, displays = | ||
== Display == | == Display == | ||
− | |||
* Generate raster plot: [[Guide_to_madagascar_programs#sfgrey | grey guide]], [http://reproducibility.org/RSF/sfgrey.html grey] (sfbyte is the same) | * Generate raster plot: [[Guide_to_madagascar_programs#sfgrey | grey guide]], [http://reproducibility.org/RSF/sfgrey.html grey] (sfbyte is the same) | ||
Line 161: | Line 93: | ||
* Vplot filter for the virtual vplot device: [http://reproducibility.org/RSF/sfvppen.html vppen] | * Vplot filter for the virtual vplot device: [http://reproducibility.org/RSF/sfvppen.html vppen] | ||
− | |||
− | |||
− |
Revision as of 12:20, 10 January 2009
List of Basic Cube Utilities (BCU) in Madagascar. Operations listed here can throw away data or fill in with zeros, but should not create new values or alter existing ones -- those belong to the Numerical Methods program list.
All program names below should be prefixed with "sf".
Contents
I/O and file format conversions
ASCII, binary file
SEG-Y file
- Convert SEG-Y files to RSF: segyread guide, segyread
- Convert RSF to SEG-Y or SU: segywrite guide, segywrite
- Make a trace header file for segywrite: segyheader guide, segyheader
SU file
- Convert SU files to RSF: suread
- Convert RSF to SU: segywrite guide, segywrite
File operations
This section contains physics-agnostic methods for slicing, dicing, adding together files, etc:
Basic operations
- Display basic information about RSF files: Guide_to_madagascar_programs#sfin in guide, in
- Copy a dataset: cp guide, cp
- Move a dataset: mv guide, mv
- Remove RSF files together with their data: rm guide, rm
- Print out data values: disfil guide, disfil
Operation on file content
- Window a portion of the dataset: window guide, window
- Transpose two axes in a dataset: transp guide, transp
- Concatenate datasets: cat guide, cat or merge guide, merge
- Convert real data to complex (by adding zero imaginary part): rtoc guide, rtoc
- Extract real part of a complex dataset: real guide, real
- Extract imaginary part of a complex dataset: imag
- Create a complex dataset from its real and imaginary parts: complex guide, cmplx
- Rotate a portion of one or more axes in the data hypercube: rotate guide, rotate
- Zero a portion of the dataset: cut guide, cut
- Pad a dataset with zeros: pad guide, pad
- Combine several datasets by interleaving: interleave guide, interleave
- Pad and interleave traces: lpad
- Compute Ni+1 x Ni+2 x ...: leftsize
- Reverse one or more axes in the data hypercube: reverse guide, reverse
Header operations
- Input parameters into a header: put guide, put
- Output parameters from the header: get guide, get
- Display the content of a header file: headerattr guide, headerattr
- Zero a portion of a dataset based on a header mask: headercut guide, headercut
- Mathematical operations, possibly on header keys: headermath guide, headermath
- Sort a dataset according to a header key: headersort guide, headersort
- Window a dataset based on a header mask: headerwindow guide, headerwindow
Graph, plots, displays
Display
- Generate raster plot: grey guide, grey (sfbyte is the same)
- Contour plot: contour guide, contour
- Generate 3-D contour plot: contour3
- Plot signal with lollipops: dots guide, dots
- Generate 3-D cube plot for surfaces: graph3 guide, graph3
- Graph plot: graph guide, graph
- Generate 3-D cube plot: grey3 guide, grey3 (sfcubeplot is the same)
- Plot rays: plotrays guide, plotrays
- Hidden-line surface plot: thplot guide, thplot
- Plot data with wiggly traces: wiggle guide, wiggle
- Resamples a 2-D dataset to the desired picture resolution, with antialias: prep4plot guide, prep4plot
- Setting up frames for a generic plot: stdplot
Plot format
- Plot Assembler - convert ascii to vplot: plas guide, plas
- Plot Debugger - convert vplot to ascii: pldb guide, pldb
- Vplot filter for postscript: pspen
- Vplot filter for the virtual vplot device: vppen