sas.sascalc.shape2sas.models package

Submodules

sas.sascalc.shape2sas.models.Cube module

class sas.sascalc.shape2sas.models.Cube.Cube(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a cube

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a cube

getVolume() → float

Returns the volume of a cube

sas.sascalc.shape2sas.models.Cuboid module

class sas.sascalc.shape2sas.models.Cuboid.Cuboid(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a Cuboid

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a cuboid

getVolume() → float

Returns the volume of a cuboid

sas.sascalc.shape2sas.models.Cylinder module

class sas.sascalc.shape2sas.models.Cylinder.Cylinder(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a cylinder

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a cylinder

getVolume() → float

Returns the volume of a cylinder

sas.sascalc.shape2sas.models.CylinderRing module

class sas.sascalc.shape2sas.models.CylinderRing.CylinderRing(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a cylinder ring

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a cylinder ring

getVolume() → float

Returns the volume of a cylinder ring

sas.sascalc.shape2sas.models.Disc module

class sas.sascalc.shape2sas.models.Disc.Disc(dimensions: list[float])

Bases: EllipticalCylinder

sas.sascalc.shape2sas.models.DiscRing module

class sas.sascalc.shape2sas.models.DiscRing.DiscRing(dimensions: list[float])

Bases: CylinderRing

sas.sascalc.shape2sas.models.Ellipsoid module

class sas.sascalc.shape2sas.models.Ellipsoid.Ellipsoid(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

check for points within a ellipsoid

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of an ellipsoid

getVolume() → float

Returns the volume of an ellipsoid

sas.sascalc.shape2sas.models.EllipticalCylinder module

class sas.sascalc.shape2sas.models.EllipticalCylinder.EllipticalCylinder(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a Elliptical cylinder

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of an elliptical cylinder

getVolume() → float

Returns the volume of an elliptical cylinder

sas.sascalc.shape2sas.models.HollowCube module

class sas.sascalc.shape2sas.models.HollowCube.HollowCube(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a hollow cube

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a hollow cube

getVolume() → float

Returns the volume of a hollow cube

sas.sascalc.shape2sas.models.HollowSphere module

class sas.sascalc.shape2sas.models.HollowSphere.HollowSphere(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a hollow sphere

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a hollow sphere

getVolume() → float

Returns the volume of a hollow sphere

sas.sascalc.shape2sas.models.Sphere module

class sas.sascalc.shape2sas.models.Sphere.Sphere(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a sphere

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a sphere

getVolume() → float

Returns the volume of a sphere

sas.sascalc.shape2sas.models.SuperEllipsoid module

class sas.sascalc.shape2sas.models.SuperEllipsoid.SuperEllipsoid(dimensions: list[float])

Bases: object

static beta(a, b) → float

beta function

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a superellipsoid

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a superellipsoid

getVolume() → float

Returns the volume of a superellipsoid

Module contents

class sas.sascalc.shape2sas.models.Cube(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a cube

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a cube

getVolume() → float

Returns the volume of a cube

class sas.sascalc.shape2sas.models.Cuboid(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a Cuboid

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a cuboid

getVolume() → float

Returns the volume of a cuboid

class sas.sascalc.shape2sas.models.Cylinder(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a cylinder

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a cylinder

getVolume() → float

Returns the volume of a cylinder

class sas.sascalc.shape2sas.models.CylinderRing(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a cylinder ring

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a cylinder ring

getVolume() → float

Returns the volume of a cylinder ring

class sas.sascalc.shape2sas.models.Disc(dimensions: list[float])

Bases: EllipticalCylinder

class sas.sascalc.shape2sas.models.DiscRing(dimensions: list[float])

Bases: CylinderRing

class sas.sascalc.shape2sas.models.Ellipsoid(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

check for points within a ellipsoid

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of an ellipsoid

getVolume() → float

Returns the volume of an ellipsoid

class sas.sascalc.shape2sas.models.EllipticalCylinder(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a Elliptical cylinder

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of an elliptical cylinder

getVolume() → float

Returns the volume of an elliptical cylinder

class sas.sascalc.shape2sas.models.HollowCube(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a hollow cube

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a hollow cube

getVolume() → float

Returns the volume of a hollow cube

class sas.sascalc.shape2sas.models.HollowSphere(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a hollow sphere

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a hollow sphere

getVolume() → float

Returns the volume of a hollow sphere

class sas.sascalc.shape2sas.models.Sphere(dimensions: list[float])

Bases: object

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a sphere

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a sphere

getVolume() → float

Returns the volume of a sphere

class sas.sascalc.shape2sas.models.SuperEllipsoid(dimensions: list[float])

Bases: object

static beta(a, b) → float

beta function

checkOverlap(x_eff: ndarray, y_eff: ndarray, z_eff: ndarray) → ndarray

Check for points within a superellipsoid

getPointDistribution(Npoints: int) → tuple[ndarray, ndarray, ndarray]

Returns the point distribution of a superellipsoid

getVolume() → float

Returns the volume of a superellipsoid