Drillholes🍋
Drillholes (GeoRefObject)
🍋
Object representing a 3D group of drillhole. Each drillhole is identified by a unique holeid.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
name |
str |
object name. |
required |
xyz |
~Data |
geometry data, respectively X, Y and Z. |
required |
holeid |
~Data |
unique identifier for each drillhole. |
required |
start |
~Data |
starting depth of edges. Sorted by ascending holeid and desecending z. |
None |
end |
~Data |
ending depth of edges. Sorted by ascending holeid and desecending z. |
None |
Exceptions:
| Type | Description |
|---|---|
ValueError |
Holeid is not defined at all points. |
ValueError |
holeid are not grouped. |
ValueError |
Start is defined but not end or vice-versa. |
ValueError |
Start greater than end when provided. |
ValueError |
Start or end values are not sorted. |
aggregate(self, properties=None, agg_methods=[<AggregationMethod.SUM: 'sum'>, <AggregationMethod.MIN: 'min'>, <AggregationMethod.MAX: 'max'>, <AggregationMethod.MEAN: 'mean'>])
🍋
Return the object data grouped by location (X, Y) and hole ID.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
properties |
List[str] |
list of properties name to transfer to the GIS Object. Setting to None or empty list will select all existing properties. |
None |
agg_methods |
List[str] |
aggregation data methods. See pandas.DataFrame.groupby to find out supported methods. |
[<AggregationMethod.SUM: 'sum'>, <AggregationMethod.MIN: 'min'>, <AggregationMethod.MAX: 'max'>, <AggregationMethod.MEAN: 'mean'>] |
Returns:
| Type | Description |
|---|---|
DataFrame |
DataFrame of XY coordinates with aggregated data. |
Exceptions:
| Type | Description |
|---|---|
ValueError |
|
Error |
if one of the agg_methods is not supported. |
collar_coords(self)
🍋
Return only coordinates of collars, being top location of each drillhole.
Returns:
| Type | Description |
|---|---|
ndarray |
XYZ coordinates of collars. |
coords(self, region=None)
🍋
Provided for convenience, return the composit mid-points (see mid_coords()).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
region |
str |
Object region to select data from. |
None |
Returns:
| Type | Description |
|---|---|
ndarray |
XYZ of the mid-points of each composite. |
element_count(self)
🍋
Return the number of drillholes in the Drillholes group.
Returns:
| Type | Description |
|---|---|
int |
Number of drillholes. |
holeids(self)
🍋
Return the holeids present in this Drillholes object
Returns:
| Type | Description |
|---|---|
ndarray |
List of Hold ID names. |
mid_coords(self, region=None)
🍋
Return Mid-Points of each composite.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
region |
str |
Object region to select data from. |
None |
Returns:
| Type | Description |
|---|---|
ndarray |
Barycentric coordinates. |
node_coords(self, region=None)
🍋
Return the object node coordinates, respectively X, Y, and Z as data arrays. Node coordinates correspond to beginning and end of each composite.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
region |
str |
Object region to select data from. |
None |
Returns:
| Type | Description |
|---|---|
ndarray |
XYZ coordinates. |
sample_count(self)
🍋
Return the total number of samples for all drillholes.
Returns:
| Type | Description |
|---|---|
int |
Number of samples for all drillholes. |