luminarycloud 0.15.4__py3-none-any.whl → 0.16.0__py3-none-any.whl

luminarycloud/vis/filters.py

@@ -15,9 +15,10 @@ from .display import Field, DisplayAttributes
 from typing import List, Any, cast
 from .primitives import Box, Plane
 from .vis_util import generate_id
+from .._helpers._code_representation import CodeRepr
 
 
-class Filter(ABC):
+class Filter(ABC, CodeRepr):
     """
     This is the base class for all filters. Each derived filter class
     is responsible for providing a _to_proto method to convert to a filter
@@ -95,7 +96,7 @@ class Slice(Filter):
         Specifies this filter's appearance.
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(generate_id("slice-"))
         self._plane = Plane()
         self._project_vectors: bool = False
@@ -166,7 +167,7 @@ class Isosurface(Filter):
         Specifies this filter's appearance.
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(generate_id("contour-"))
         self.isovalues: List[float] = []
         self.field: Field = Field()
@@ -188,7 +189,10 @@ class Isosurface(Filter):
         vis_filter.id = self.id
         vis_filter.name = self.name
         vis_filter.contour.field.quantity_typ = self.field.quantity.value
-        vis_filter.contour.field.component = self.field.component.value
+        if not quantity_type._is_vector(self.field.quantity):
+            vis_filter.contour.field.component = vis_pb2.Field.COMPONENT_UNSPECIFIED
+        else:
+            vis_filter.contour.field.component = self.field.component.value
         for val in self.isovalues:
             vis_filter.contour.iso_values.append(val)
         return vis_filter
@@ -200,7 +204,11 @@ class Isosurface(Filter):
         self.id = filter.id
         self.name = filter.name
         self.field.quantity = VisQuantity(filter.contour.field.quantity_typ)
-        self.field.component = FieldComponent(filter.contour.field.component)
+        if not quantity_type._is_vector(self.field.quantity):
+            # This is a scalar so just set the component to magnitude which is the default.
+            self.field.component = FieldComponent.MAGNITUDE
+        else:
+            self.field.component = FieldComponent(filter.contour.field.component)
         self.isovalues.clear()
         for val in filter.contour.iso_values:
             self.isovalues.append(val)
@@ -226,11 +234,9 @@ class PlaneClip(Filter):
         are removed. Default: False
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(generate_id("planeClip-"))
         self._plane: Plane = Plane()
-        # TODO(matt): We could make this a prop to that is unsettable. Or we could
-        # not use ids and force that the filter names are unique.
         self.name = name
         self.inverted: bool = False
 
@@ -289,7 +295,7 @@ class BoxClip(Filter):
         Default : False
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(generate_id("boxClip-"))
         self._box: Box = Box()
         self.name = name
@@ -351,17 +357,11 @@ class VectorGlyphs(Filter):
 
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(generate_id("vector-"))
         self.name: str = name
-        # TODO(matt): we should be able to help set some reasonable defaults bases
-        # on the mesh size (i.e., number of points) and bounds (the default glyph size).
-        # The scene has accesss to this theoretically. Perhaps the scene class can be used
-        # as a factory.
         self._sampling_rate: int = 500
-        self.field: Field = Field()
-        # TODO(matt): we should only allow vectors somehow
-        self.field.quantity = VisQuantity.VELOCITY
+        self.quantity: VisQuantity = VisQuantity.VELOCITY
 
     @property
     def sampling_rate(self) -> int:
@@ -396,11 +396,11 @@ class FixedSizeVectorGlyphs(VectorGlyphs):
         The size in world units (meters) of the glyphs.
     display_attrs (DisplayAttributes)
         Specifies this filters appearance.
-    field: Field
+    quantity: VisQuantity
         The vector field to use for glyph generation. Default: Velocity
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(name)
         self.size: float = 1.0
 
@@ -411,10 +411,10 @@ class FixedSizeVectorGlyphs(VectorGlyphs):
         vis_filter.glyph.fixed_size_glyphs = self.size
         vis_filter.glyph.n_glyphs = self.sampling_rate
         vis_filter.glyph.sampling_mode = vis_pb2.GLYPH_SAMPLING_MODE_EVERY_NTH
-        if not quantity_type._is_vector(self.field.quantity):
+        if not quantity_type._is_vector(self.quantity):
             raise ValueError("FixedSizeVectorGlyphs: field must be a vector type")
-        vis_filter.glyph.field.quantity_typ = self.field.quantity.value
-        vis_filter.glyph.field.component = self.field.component.value
+        vis_filter.glyph.field.quantity_typ = self.quantity.value
+        vis_filter.glyph.field.component = vis_pb2.Field.COMPONENT_UNSPECIFIED
         return vis_filter
 
     def _from_proto(self, filter: vis_pb2.Filter) -> None:
@@ -429,8 +429,7 @@ class FixedSizeVectorGlyphs(VectorGlyphs):
         self.n_glyphs = filter.glyph.n_glyphs
         self.size = filter.glyph.fixed_size_glyphs
         self.sampling_rate = filter.glyph.n_glyphs
-        self.field.quantity = VisQuantity(filter.glyph.field.quantity_typ)
-        self.field.component = FieldComponent(filter.glyph.field.component)
+        self.quantity = VisQuantity(filter.glyph.field.quantity_typ)
 
 
 class ScaledVectorGlyphs(VectorGlyphs):
@@ -457,11 +456,11 @@ class ScaledVectorGlyphs(VectorGlyphs):
         0.5 and the scale is 2 then the resulting world space size is 1 meter. Default: 1.
     display_attrs (DisplayAttributes)
         Specifies this filters appearance.
-    field: Field
+    quantity: VisQuantity
         The vector field to use for glyph generation. Default: Velocity
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(name)
         self.scale: float = 1.0
 
@@ -472,10 +471,10 @@ class ScaledVectorGlyphs(VectorGlyphs):
         vis_filter.glyph.glyph_scale_size = self.scale
         vis_filter.glyph.n_glyphs = self.sampling_rate
         vis_filter.glyph.sampling_mode = vis_pb2.GLYPH_SAMPLING_MODE_EVERY_NTH
-        if not quantity_type._is_vector(self.field.quantity):
+        if not quantity_type._is_vector(self.quantity):
             raise ValueError("ScaledVectorGyph: field must be a vector type")
-        vis_filter.glyph.field.quantity_typ = self.field.quantity.value
-        vis_filter.glyph.field.component = self.field.component.value
+        vis_filter.glyph.field.quantity_typ = self.quantity.value
+        vis_filter.glyph.field.component = vis_pb2.Field.COMPONENT_UNSPECIFIED
         return vis_filter
 
     def _from_proto(self, filter: vis_pb2.Filter) -> None:
@@ -490,8 +489,7 @@ class ScaledVectorGlyphs(VectorGlyphs):
         self.n_glyphs = filter.glyph.n_glyphs
         self.scale = filter.glyph.glyph_scale_size
         self.sampling_rate = filter.glyph.n_glyphs
-        self.field.quantity = VisQuantity(filter.glyph.field.quantity_typ)
-        self.field.component = FieldComponent(filter.glyph.field.component)
+        self.quantity = VisQuantity(filter.glyph.field.quantity_typ)
 
 
 class Threshold(Filter):
@@ -526,7 +524,7 @@ class Threshold(Filter):
         Specifies this filter's appearance.
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(generate_id("threshold-"))
         self.field: Field = Field()
         self.min_value: float = 0.0
@@ -559,6 +557,10 @@ class Threshold(Filter):
         vis_filter.threshold.range.min = self.min_value
         vis_filter.threshold.range.max = self.max_value
         vis_filter.threshold.field.quantity_typ = self.field.quantity.value
+        if not quantity_type._is_vector(self.field.quantity):
+            vis_filter.threshold.field.component = vis_pb2.Field.COMPONENT_UNSPECIFIED
+        else:
+            vis_filter.threshold.field.component = self.field.component.value
         vis_filter.threshold.field.component = self.field.component.value
         vis_filter.threshold.smooth = self.smooth
         vis_filter.threshold.invert = self.invert
@@ -577,7 +579,11 @@ class Threshold(Filter):
         self.invert = filter.threshold.invert
         self.strict = filter.threshold.strict
         self.field.quantity = VisQuantity(filter.threshold.field.quantity_typ)
-        self.field.component = FieldComponent(filter.threshold.field.component)
+        if not quantity_type._is_vector(self.field.quantity):
+            # This is a scalar so just set the component to magnitude which is the default.
+            self.field.component = FieldComponent.MAGNITUDE
+        else:
+            self.field.component = FieldComponent(filter.threshold.field.component)
 
 
 class Streamlines(Filter):
@@ -595,14 +601,13 @@ class Streamlines(Filter):
         Specifies this filter's appearance.
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(generate_id("streamlines-"))
         self.name: str = name
         self.n_streamlines: int = 100
         self.max_length: float = 10
         self.direction: StreamlineDirection = StreamlineDirection.FORWARD
-        self.field: Field = Field()
-        self.field.quantity = VisQuantity.VELOCITY
+        self.quantity: VisQuantity = VisQuantity.VELOCITY
 
 
 class RakeStreamlines(Streamlines):
@@ -625,7 +630,7 @@ class RakeStreamlines(Streamlines):
         The number of seed particles to place on the rake. Default: 100
     max_length: float
         The maximum path length of the particle in meters. Default: 10
-    field: Field
+    quantity: VisQuantity
         The vector field to used for the particle advection. Default: Velocity
     start: Vector3Like
         The start point of the rake. Default: [0,0,0].
@@ -637,10 +642,10 @@ class RakeStreamlines(Streamlines):
         Specifies this filter's appearance.
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(name)
-        self.start: Vector3Like = dc.field(default_factory=lambda: Vector3(x=0, y=0, z=0))
-        self.end: Vector3Like = dc.field(default_factory=lambda: Vector3(x=1, y=0, z=0))
+        self.start: Vector3Like = Vector3(x=0, y=0, z=0)
+        self.end: Vector3Like = Vector3(x=1, y=0, z=0)
 
     def _to_proto(self) -> vis_pb2.Filter:
         # Type checking
@@ -648,8 +653,8 @@ class RakeStreamlines(Streamlines):
             raise TypeError(f"Expected 'int', got {type(self.n_streamlines).__name__}")
         if not isinstance(self.max_length, (float, int)):
             raise TypeError(f"Expected 'float or int', got {type(self.max_length).__name__}")
-        if not isinstance(self.field, Field):
-            raise TypeError(f"Expected 'Field', got {type(self.field).__name__}")
+        if not isinstance(self.quantity, VisQuantity):
+            raise TypeError(f"Expected 'VisQuantity', got {type(self.quantity).__name__}")
 
         vis_filter = vis_pb2.Filter()
         vis_filter.id = self.id
@@ -658,9 +663,9 @@ class RakeStreamlines(Streamlines):
         vis_filter.streamlines.max_length = self.max_length
         vis_filter.streamlines.rake.start.CopyFrom(_to_vector3(self.start)._to_proto())
         vis_filter.streamlines.rake.end.CopyFrom(_to_vector3(self.end)._to_proto())
-        if not quantity_type._is_vector(self.field.quantity):
+        if not quantity_type._is_vector(self.quantity):
             raise ValueError("RakeStreamlines: field must be a vector type")
-        vis_filter.streamlines.field.quantity_typ = self.field.quantity.value
+        vis_filter.streamlines.field.quantity_typ = self.quantity.value
         return vis_filter
 
     def _from_proto(self, filter: vis_pb2.Filter) -> None:
@@ -679,7 +684,7 @@ class RakeStreamlines(Streamlines):
         self.start._from_proto(filter.streamlines.rake.start)
         self.end = Vector3()
         self.end._from_proto(filter.streamlines.rake.end)
-        self.field.quantity = VisQuantity(filter.streamlines.field.quantity_typ)
+        self.quantity = VisQuantity(filter.streamlines.field.quantity_typ)
 
 
 class SurfaceStreamlines(Streamlines):
@@ -726,7 +731,7 @@ class SurfaceStreamlines(Streamlines):
         particles further into the volume based on the surface normal.  Default: 0.0
     max_length: float
         The maximum path length of the particle in meters. Default: 10
-    field: Field
+    quantity: VisQuantity
         The vector field to used for the particle advection. Default: Velocity
     name : str
         A user provided name for the filter.
@@ -734,7 +739,7 @@ class SurfaceStreamlines(Streamlines):
         Specifies this filter's appearance.
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(name)
         self.offset: float = 0.0
         self._surface_names: List[str] = []
@@ -768,8 +773,8 @@ class SurfaceStreamlines(Streamlines):
             raise TypeError(f"Expected 'float or int', got {type(self.max_length).__name__}")
         if not isinstance(self.offset, (float, int)):
             raise TypeError(f"Expected 'float or int', got {type(self.offset).__name__}")
-        if not isinstance(self.field, Field):
-            raise TypeError(f"Expected 'Field', got {type(self.field).__name__}")
+        if not isinstance(self.quantity, VisQuantity):
+            raise TypeError(f"Expected 'VisQuantity', got {type(self.quantity).__name__}")
         if not isinstance(self.mode, SurfaceStreamlineMode):
             raise TypeError(f"Expected 'SurfaceStreamlinesMode', got {type(self.mode).__name__}")
 
@@ -781,12 +786,12 @@ class SurfaceStreamlines(Streamlines):
         project = False
         # Prevent common mistakes that cause confusion.
         if self.mode == SurfaceStreamlineMode.ADVECT_ON_SURFACE:
-            if self.field.quantity == VisQuantity.VELOCITY:
+            if self.quantity == VisQuantity.VELOCITY:
                 raise ValueError(
                     "SurfacesStreamines: velocity is 0 on surfaces and will produce no data"
                 )
             project = True
-        elif self.field.quantity == VisQuantity.WALL_SHEAR_STRESS:
+        elif self.quantity == VisQuantity.WALL_SHEAR_STRESS:
             raise ValueError(
                 "SurfacesStreamines: wall shear stress is 0 in the volume and will produce no data "
             )
@@ -796,10 +801,9 @@ class SurfaceStreamlines(Streamlines):
             raise ValueError("SurfaceStreamlines: need at least one surfaces specified.")
         for id in self._surface_names:
             vis_filter.streamlines.surface.surface_names.append(id)
-        if not quantity_type._is_vector(self.field.quantity):
-            raise ValueError("SurfaceStreamlines: field must be a vector type")
-        vis_filter.streamlines.field.component = self.field.component.value
-        vis_filter.streamlines.field.quantity_typ = self.field.quantity.value
+        if not quantity_type._is_vector(self.quantity):
+            raise ValueError("SurfaceStreamlines: quantity must be a vector type")
+        vis_filter.streamlines.field.quantity_typ = self.quantity.value
         return vis_filter
 
     def _from_proto(self, filter: vis_pb2.Filter) -> None:
@@ -816,7 +820,15 @@ class SurfaceStreamlines(Streamlines):
         self._surface_names.clear()
         for s in filter.streamlines.surface.surface_names:
             self._surface_names.append(s)
-        self.field.quantity = VisQuantity(filter.streamlines.field.quantity_typ)
+        self.quantity = VisQuantity(filter.streamlines.field.quantity_typ)
+
+    def _to_code(self, hide_defaults: bool = True, use_tmp_objs: bool = True) -> str:
+        code = super()._to_code(hide_defaults=hide_defaults)
+        # We need to explicity write the code for the surfaces since its
+        # technically a private variable.
+        for s in self._surface_names:
+            code += f".add_surface('{s}')\n"
+        return code
 
 
 class SurfaceLIC(Filter):
@@ -840,7 +852,7 @@ class SurfaceLIC(Filter):
 
     Attributes:
     -----------
-    field: Field
+    quantity: VisQuantity
         Specifies the field used to advect particles for the surface LIC.
         Default: WALL_SHEER_STRESS
     contrast: float
@@ -849,13 +861,12 @@ class SurfaceLIC(Filter):
         higher values mean more contrast. Default: 1
     """
 
-    def __init__(self, name: str) -> None:
+    def __init__(self, name: str = "") -> None:
         super().__init__(generate_id("surface-lic-"))
         self.name = name
         self.contrast: float = 1.0
         self._surface_names: List[str] = []
-        self.field: Field = Field()
-        self.field.quantity = VisQuantity.WALL_SHEAR_STRESS
+        self.quantity: VisQuantity = VisQuantity.WALL_SHEAR_STRESS
 
     def add_surface(self, id: str) -> None:
         """
@@ -883,9 +894,9 @@ class SurfaceLIC(Filter):
         vis_filter.name = self.name
         # Prevent common mistakes that cause confusion. The only current option
         # is to be on a surface, so no velocity.
-        if not isinstance(self.field, Field):
-            raise TypeError(f"Expected 'Field', got {type(self.field).__name__}")
-        if self.field.quantity == VisQuantity.VELOCITY:
+        if not isinstance(self.quantity, VisQuantity):
+            raise TypeError(f"Expected 'VisQuantity', got {type(self.quantity).__name__}")
+        if self.quantity == VisQuantity.VELOCITY:
             raise ValueError("SurfaceLIC: velocity is 0 on surfaces and will produce no data")
         if not isinstance(self.contrast, (int, float)):
             raise TypeError(f"Expected 'int or float', got {type(self.contrast).__name__}")
@@ -899,7 +910,7 @@ class SurfaceLIC(Filter):
             geometry = vis_pb2.SurfaceLICGeomtery()
             vis_filter.surface_lic.geometry.CopyFrom(geometry)
 
-        vis_filter.surface_lic.field.quantity_typ = self.field.quantity.value
+        vis_filter.surface_lic.field.quantity_typ = self.quantity.value
         vis_filter.surface_lic.contrast = self.contrast
         return vis_filter
 
@@ -917,7 +928,44 @@ class SurfaceLIC(Filter):
         self._surface_names = []
         for s in filter.surface_lic.geometry.surface_names:
             self._surface_names.append(s)
-        if not quantity_type._is_vector(self.field.quantity):
-            raise ValueError("SurfaceLIC: field must be a vector type")
-        self.field.quantity = VisQuantity(filter.surface_lic.field.quantity_typ)
-        self.field.component = FieldComponent(filter.surface_lic.field.component)
+        if not quantity_type._is_vector(self.quantity):
+            raise ValueError("SurfaceLIC: quantity must be a vector type")
+        self.quantity = VisQuantity(filter.surface_lic.field.quantity_typ)
+
+    def _to_code(self, hide_defaults: bool = True, use_tmp_objs: bool = True) -> str:
+        code = super()._to_code(hide_defaults=hide_defaults)
+        # We need to explicity write the code for the surfaces since its
+        # technically a private variable.
+        for s in self._surface_names:
+            code += f".add_surface('{s}')\n"
+        return code
+
+
+def _filter_to_obj_name(filter: Filter) -> str:
+    """
+    Helper function to convert a filter to a code object name used in code gen.
+    """
+    if not isinstance(filter, Filter):
+        raise TypeError(f"Expected 'Filter', got {type(filter).__name__}")
+    if isinstance(filter, Slice):
+        return "slice"
+    elif isinstance(filter, Isosurface):
+        return "isosurface"
+    elif isinstance(filter, PlaneClip):
+        return "plane_clip"
+    elif isinstance(filter, BoxClip):
+        return "box_clip"
+    elif isinstance(filter, FixedSizeVectorGlyphs):
+        return "fixed_size_vector_glyphs"
+    elif isinstance(filter, ScaledVectorGlyphs):
+        return "scaled_vector_glyphs"
+    elif isinstance(filter, Threshold):
+        return "threshold"
+    elif isinstance(filter, RakeStreamlines):
+        return "rake_streamlines"
+    elif isinstance(filter, SurfaceStreamlines):
+        return "surface_streamlines"
+    elif isinstance(filter, SurfaceLIC):
+        return "surface_lic"
+    else:
+        raise TypeError(f"Unknown filter type: {type(filter).__name__}")

luminarycloud/vis/primitives.py

@@ -1,10 +1,11 @@
 # Copyright 2023-2024 Luminary Cloud, Inc. All Rights Reserved.
 import dataclasses as dc
 from luminarycloud.types import Vector3, Vector3Like
+from .._helpers._code_representation import CodeRepr
 
 
 @dc.dataclass
-class Plane:
+class Plane(CodeRepr):
     """
     This class defines a plane.
 
@@ -19,7 +20,7 @@ class Plane:
 
 
 @dc.dataclass
-class Box:
+class Box(CodeRepr):
     """
     This class defines a box used for filter such as box clip.