BoxEnvelope

Instance Constructors

new BoxEnvelope(env: BoxEnvelope)

Clones an existing cube Envelope to create a duplicate cube Envelope.
Clones an existing cube Envelope to create a duplicate cube Envelope.
env
original cube Envelope to be cloned
new BoxEnvelope(p1: Point3D)

Creates an cube Envelope for a region defined one coordinate.
Creates an cube Envelope for a region defined one coordinate. The cube Envelope in this case will be a point.
p1
the coordinate
new BoxEnvelope(p1: Point3D, p2: Point3D)

Creates an cube Envelope for a region defined by two coordinates.
Creates an cube Envelope for a region defined by two coordinates.
p1
first coordinate
p2
second coordinate
new BoxEnvelope(p1: Point3D, p2: Point3D, p3: Point3D)

Creates an cube Envelope for a region defined by three coordinates.
Creates an cube Envelope for a region defined by three coordinates.
p1
first coordinate
p2
second coordinate
p3
third coordinate
new BoxEnvelope()

Creates a null cube Envelope

Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def asInstanceOf[T0]: T0

Definition Classes
Any
val center: Point3D

The center
The center

Definition Classes
BoxEnvelope → Shape3D
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def contains(x: Double, y: Double, z: Double): Boolean

Tests if the given point lies in or on the envelope.
Tests if the given point lies in or on the envelope.
x
the x-coordinate of the point for which the containment is to be checked
y
the y-coordinate of the point for which the containment is to be checked
z
the z-coordinate of the point for which the containment is to be checked
returns
true if (x, y, z) lies in the interior or on the boundary of this cube Envelope, false if the cube Envelope is null.
def contains(env: BoxEnvelope): Boolean

Tests if the cube Envelope other lies wholely inside this cube Envelope (inclusive of the boundary).
Tests if the cube Envelope other lies wholely inside this cube Envelope (inclusive of the boundary).
env
the cube Envelope to check
returns
true if this cube Envelope covers the other cube Envelope, false if either of these cube Envelope is null
def contains(p: Point3D): Boolean

Tests if the given point lies in or on the envelope.
Tests if the given point lies in or on the envelope.
p
Point3D to be checked for the containment
returns
true if the p lies in the interior or on the boundary of this cube Envelope, false if the cube Envelope is null.
def covers(env: BoxEnvelope): Boolean

Tests if the cube Envelope other lies completely inside this cube Envelope (inclusive of the boundary).
Tests if the cube Envelope other lies completely inside this cube Envelope (inclusive of the boundary).
env
the cube Envelope to check
returns
true if this cube Envelope covers the other cube Envelope, false if either of these cube Envelope is null
def covers(x: Double, y: Double, z: Double): Boolean

Tests if the given point lies in or on the envelope.
Tests if the given point lies in or on the envelope.
x
the x-coordinate of the point for which this cube Envelope is being checked for containment
y
the y-coordinate of the point for which this cube Envelope is being checked for containment
z
the z-coordinate of the point for which this cube Envelope is being checked for containment
returns
true if (x, y, z) lies in the interior or on the boundary of this cube Envelope, false if the cube Envelope is null.
def covers(p: Point3D): Boolean

Tests if the given point lies in or on the envelope.
Tests if the given point lies in or on the envelope.
p
Point3D to be checked for the containment
returns
true if the p lies in the interior or on the boundary of this cube Envelope, false if the cube Envelope is null.
def distance(env: BoxEnvelope): Double

Computes the distance between this and another cube Envelope The distance between overlapping cube Envelopes is 0.
Computes the distance between this and another cube Envelope The distance between overlapping cube Envelopes is 0. Otherwise, the distance is the Euclidean distance between the closest points.
env
the other cube Envelope from which distance is to be computed
returns
the distance between the two cube Envelopes
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def expandBy(deltaX: Double, deltaY: Double, deltaZ: Double): Unit

Expand cube Envelope by given distances along the three dimension.
Expand cube Envelope by given distances along the three dimension.
deltaX
the distance to expand the cube Envelope along the the X axis
deltaY
the distance to expand the cube Envelope along the the Y axis
deltaZ
the distance to expand the cube Envelope along the the Z axis
def expandBy(delta: Double): Unit

Expand cube Envelope by given distance along the all three dimensions.
Expand cube Envelope by given distance along the all three dimensions.
delta
the distance to expand the cube Envelope along all the axes
def expandToInclude(env: BoxEnvelope): Unit

Expand the cube Envelope so that it includes the other cube Envelope.
Expand the cube Envelope so that it includes the other cube Envelope.
env
the cube Envelope to expand to include
def expandToInclude(x: Double, y: Double, z: Double): Unit

Enlarges this cube Envelope so that it contains the given point.
Enlarges this cube Envelope so that it contains the given point. Has no effect if the point is already on or within the envelope.
x
the value to lower the minimum x to or to raise the maximum x to
y
the value to lower the minimum y to or to raise the maximum y to
z
the value to lower the minimum z to or to raise the maximum z to
def expandToInclude(p: Point3D): Unit

Expand the cube Envelope so that it contains the given Point
Expand the cube Envelope so that it contains the given Point
p
the Point to expand to include
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def getEnvelope: BoxEnvelope

The box envelope is already an envelope!
The box envelope is already an envelope!
returns
(BoxEnvelope) the BoxEnvelope instance.

Definition Classes
BoxEnvelope → Shape3D
def getVolume(): Double

Returns the volume of the cube Envelope.
Returns the volume of the cube Envelope.
returns
the volume of the envelope, 0.0 if the cube Envelope is null
def getXLength(): Double

Return the difference between max and min X values of the cube Envelope.
Return the difference between max and min X values of the cube Envelope.
returns
maxX - minX, or 0 if the cube Envelope is null
def getYLength(): Double

Returns the difference between max and min Y value of the cube Envelope.
Returns the difference between max and min Y value of the cube Envelope.
returns
maxX - minY, or 0 if the cube Envelope is null
def getZLength(): Double

Return the difference between max and min Z value of the cube Envelope.
Return the difference between max and min Z value of the cube Envelope.
returns
maxZ - minZ, or 0 if the cube Envelope is null
def hasCenterCloseTo(p: Point3D, epsilon: Double): Boolean

Return if the input Point3D is equal this Point3D
Return if the input Point3D is equal this Point3D
p
Point3D for which the comparison has to be done
returns
true if the two Point3D centers are within epsilon

Definition Classes
Shape3D
def hashCode(): Int

Definition Classes
AnyRef → Any
var indexID: Int

Attach an id to the BoxEnvelope to be used while assigning partition ID.
def intersection(env: BoxEnvelope): BoxEnvelope

Comptutes the intersection of the two cube Envelopes
Comptutes the intersection of the two cube Envelopes
env
the envelope to find intersection with
returns
a new cube Envelope representing the intersection of the envelopes (this will be the null envelope if either if the envelopes is null, or they do not intersect
def intersects(x: Double, y: Double, z: Double): Boolean

Check if the point (x, y, z) intersects (lies inside) the region of this cube Envelope.
Check if the point (x, y, z) intersects (lies inside) the region of this cube Envelope.
x
the x-coordinate of the point
y
the y-coordinate of the point
z
the z-coordinate of the point
returns
true if the point overlaps this cube Envelope
def intersects(p1: Point3D, p2: Point3D, p3: Point3D): Boolean

Checks if the region the three external points intersects the region of this cube Envelope.
Checks if the region the three external points intersects the region of this cube Envelope.
p1
the first external point
p2
the second external point
p3
the third external point
returns
true if the region intersects the other cube Envelope
def intersects(env: BoxEnvelope): Boolean

Checks if the region of the input cube Envelope intersects the region of this cube Envelope.
Checks if the region of the input cube Envelope intersects the region of this cube Envelope.
env
the cube Envelope with which the intersection is being checked
returns
true if the cube Envelope intersects the other cube Envelope
def isEqual(other: AnyRef): Boolean

Checks if the input cube Envelope is equal to the this cube Envelope.
Checks if the input cube Envelope is equal to the this cube Envelope. Return false if the input Object is not an instance of the cube Envelope class or either of these cube Envelopes is Empty.
other
the other cube Envelope for which the equality is to be checked
returns
true if the two cube Envelopes are equal, false otherwise
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
def isNull(): Boolean

Checks if this is a null envelope or not.
Checks if this is a null envelope or not.
returns
if this cube Envelope is null (empty Geometry) or nots
def maxExtent(): Double

Gets maximum extent of this cube Envelope across all three dimensions.
Gets maximum extent of this cube Envelope across all three dimensions.
returns
the maximum extent of this cube Envelope
var maxX: Double

maximum coordinate of cube Envelope along X-axis
var maxY: Double

maximum coordinate of cube Envelope along Y-axis
var maxZ: Double

maximum coordinate of cube Envelope along Z-axis
def minExtent(): Double

Gets minimum extent of this cube Envelope across all three dimensions.
Gets minimum extent of this cube Envelope across all three dimensions.
returns
the minimum extent of this cube Envelope
var minX: Double

minimum coordinate of cube Envelope along X-axis
var minY: Double

minimum coordinate of cube Envelope along Y-axis
var minZ: Double

minimum coordinate of cube Envelope along Z-axis
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def setToNull: Unit

Sets this cube Envelope to null
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
def toHealpix(nside: Int, thetaphi: Boolean = false): Long

Compute the healpix index of the geometry center.
Compute the healpix index of the geometry center. By default, the method considers that this.y = ra, this.z = dec. You can also bypass that, and force this.y = theta, this.z = phi by setting thetaphi = true. We only consider the RING scheme for the moment.
nside
: (Int) Resolution of the healpix map.
thetaphi
: (Boolean) Convention for your data: this.y = ra, this.z = dec if false, this.y = theta, this.z = phi otherwise. Default is false.
returns
(Long) Healpix index of the point for the resolution chosen.

Definition Classes
Shape3D
def toString(): String

Represent the cube Envelope as a String
Represent the cube Envelope as a String
returns
String representation of the cube Envelope

Definition Classes
BoxEnvelope → AnyRef → Any
def translate(transX: Double, transY: Double, transZ: Double): Unit

Translates/move this envelope by given amounts in the X, Y and Z direction.
Translates/move this envelope by given amounts in the X, Y and Z direction.
transX
the amount to translate along the X axis
transY
the amount to translate along the Y axis
transZ
the amount to translate along the Z axis
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Docs: object BoxEnvelope | package geometryObjects

class BoxEnvelope extends Shape3D with Serializable

Instance Constructors

new BoxEnvelope(env: BoxEnvelope)

new BoxEnvelope(p1: Point3D)

new BoxEnvelope(p1: Point3D, p2: Point3D)

new BoxEnvelope(p1: Point3D, p2: Point3D, p3: Point3D)

new BoxEnvelope()

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

final def asInstanceOf[T0]: T0

val center: Point3D

def clone(): AnyRef

def contains(x: Double, y: Double, z: Double): Boolean

def contains(env: BoxEnvelope): Boolean

def contains(p: Point3D): Boolean

def covers(env: BoxEnvelope): Boolean

def covers(x: Double, y: Double, z: Double): Boolean

def covers(p: Point3D): Boolean

def distance(env: BoxEnvelope): Double

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def expandBy(deltaX: Double, deltaY: Double, deltaZ: Double): Unit

def expandBy(delta: Double): Unit

def expandToInclude(env: BoxEnvelope): Unit

def expandToInclude(x: Double, y: Double, z: Double): Unit

def expandToInclude(p: Point3D): Unit

def finalize(): Unit

final def getClass(): Class[_]

def getEnvelope: BoxEnvelope

def getVolume(): Double

def getXLength(): Double

def getYLength(): Double

def getZLength(): Double

def hasCenterCloseTo(p: Point3D, epsilon: Double): Boolean

def hashCode(): Int

var indexID: Int

def intersection(env: BoxEnvelope): BoxEnvelope

def intersects(x: Double, y: Double, z: Double): Boolean

def intersects(p1: Point3D, p2: Point3D, p3: Point3D): Boolean

def intersects(env: BoxEnvelope): Boolean

def isEqual(other: AnyRef): Boolean

final def isInstanceOf[T0]: Boolean

def isNull(): Boolean

def maxExtent(): Double

var maxX: Double

var maxY: Double

var maxZ: Double

def minExtent(): Double

var minX: Double

var minY: Double

var minZ: Double

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def setToNull: Unit

final def synchronized[T0](arg0: ⇒ T0): T0

def toHealpix(nside: Int, thetaphi: Boolean = false): Long

def toString(): String

def translate(transX: Double, transY: Double, transZ: Double): Unit

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Serializable

Inherited from Serializable

Inherited from Shape3D

Inherited from AnyRef

Inherited from Any

Ungrouped