search

gmggroup / omf-python

Python library for working with OMF files
MIT License
79 stars 20 forks source link

Rename grid 'origin' to 'corner' #54

Closed fwkoch closed 3 years ago

rowanc1 commented 5 years ago

This was a decision at the GMG Meeting.

banesullivan commented 5 years ago

-1 from me

Is there any specific motivation behind this? Are there other libraries that use the "corner" naming convention? I'm used to "origin" but haven't seen "corner" before

I'd understand aliasing origin with corner but not outright renaming it

fwkoch commented 5 years ago

This is a decision out of the recent GMG steering meeting on OMFv2. The "corner" naming convention is used in some mining software packages. Using "corner" instead of "origin" helps clarify two ambiguities:

  1. Origin of block model vs. origin of plot - Using "corner" makes it slightly more clear that this is the "corner of the block relative to the plot origin" rather than one origin relative to another origin.
  2. Reference to centroid of corner block or corner of corner block - many mining packages deal solely with centroids and users may assume "origin" is the origin centroid. "Corner" makes the distinction more explicit - this is the absolute corner, not a centroid.
banesullivan commented 5 years ago

Thanks, @fwkoch! Those are fair points

Would this fully deprecate the origin property or switch meaning of that property?

fwkoch commented 5 years ago

There would no longer be an origin property. All spatial reference will now be relative to the coordinate_reference_system.

This means we could potentially alias corner with origin in the client libraries, since they have pretty much the same meaning between v1 and v2.

fwkoch commented 5 years ago

For implementation details - see my comment here: https://github.com/gmggroup/omf/issues/41#issuecomment-476482236

As a summary, this issue should likely be tackled at the same time as #41 since in the v1 implementation, origin is defined on a base class, not on the grid subclasses.