Skip to content

Changed mechanism for specifying shapemodel RayTraceEngine keywords from IsisPreferences to BulletEngineSelect.pref preference file #5809

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 3 commits into
base: dev
Choose a base branch
from
Open

Changed mechanism for specifying shapemodel RayTraceEngine keywords from IsisPreferences to BulletEngineSelect.pref preference file #5809

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ae0e4d6
Adding BulletEngineSelect.pref preference file to ISIS3/isis folder. …
KrisBecker Jan 24, 2019
a7d97ad
Changed mechanism for specifying shapemodel RayTraceEngine keywords f…
kledmundson May 19, 2025
f4afcb3
Added comment block to BulletEngineSelect.pref. Addresses #5807.
kledmundson May 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ ctest FunctionalTestJigsawApollo to validate this output. [#5710](https://github
- Added ShowDeprecated option to show or hide warnings in IsisPreferences. [#5611](https://github.com/DOI-USGS/ISIS3/issues/5611)

### Changed
- Changed mechanism for specifying shapemodel RayTraceEngine keywords from IsisPreferences to BulletEngineSelect.pref file. BulletEngineSelect.pref was added to ISIS3/isis and CMakeLists.txt updated so that the file is copied to $ISISROOT by cmake. [#5807](https://github.com/DOI-USGS/ISIS3/issues/5807)
- Removed Arm dependency on xalan-c, as it does not build for now on conda-forge. This requires turning off doc building on Arm. Also changed some variables to avoid name clashes on Arm with clang 16. [#5802])(https://github.com/DOI-USGS/ISIS3/pull/5802)
- Update OSIRIS-REx OCams instrument (Map, Poly, & SamCam) support to current state in UofA code base [#5426](https://github.com/DOI-USGS/ISIS3/issues/5426)
- Enhanced csminit by removing the need to specify model and plugin [#5585](https://github.com/DOI-USGS/ISIS3/issues/5585)
Expand Down
18 changes: 18 additions & 0 deletions isis/BulletEngineSelect.pref
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
########################################################
# Specifies Bullet ray-tracing engine for processing with
# shape models.
#
# RayTraceEngine = Bullet
# OnError = Continue | Fail
# Tolerance = { numerical value that will be set as the
# tolerance for the Bullet or Embree shape
# model }
#
########################################################

Group = ShapeModel
RayTraceEngine = Bullet
OnError = Continue
EndGroup

End
3 changes: 3 additions & 0 deletions isis/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -421,6 +421,7 @@ install(CODE "EXECUTE_PROCESS(COMMAND rm -f ${CMAKE_INSTALL_PREFIX}/lib/libisis$
install(CODE "EXECUTE_PROCESS(COMMAND rm -f ${CMAKE_INSTALL_PREFIX}/lib/libisis${VERSION_MAJOR}${SO})")
EXECUTE_PROCESS(COMMAND cp -f ${CMAKE_SOURCE_DIR}/TestPreferences ${CMAKE_BINARY_DIR}/)
install(CODE "EXECUTE_PROCESS(COMMAND cp -f ${CMAKE_SOURCE_DIR}/IsisPreferences ${CMAKE_INSTALL_PREFIX}/)")
install(CODE "EXECUTE_PROCESS(COMMAND cp -f ${CMAKE_SOURCE_DIR}/BulletEngineSelect.pref ${CMAKE_INSTALL_PREFIX}/)")

# Install the header files
install(CODE "EXECUTE_PROCESS(COMMAND mkdir -p ${CMAKE_INSTALL_PREFIX}/include/isis)")
Expand Down Expand Up @@ -615,12 +616,14 @@ add_custom_target(clean_source COMMAND rm -rf "${CMAKE_BINARY_DIR}/*" "${CMAKE_I

# Set up a few top level files for installation.
EXECUTE_PROCESS(COMMAND cp -f ${CMAKE_SOURCE_DIR}/IsisPreferences ${CMAKE_BINARY_DIR})
EXECUTE_PROCESS(COMMAND cp -f ${CMAKE_SOURCE_DIR}/BulletEngineSelect.pref ${CMAKE_BINARY_DIR})
EXECUTE_PROCESS(COMMAND cp -rf ${CMAKE_SOURCE_DIR}/scripts ${CMAKE_BINARY_DIR})
EXECUTE_PROCESS(COMMAND cp -f ${CMAKE_SOURCE_DIR}/../LICENSE.md ${CMAKE_BINARY_DIR})
EXECUTE_PROCESS(COMMAND cp -rf ${CMAKE_SOURCE_DIR}/make ${CMAKE_BINARY_DIR})

# Copy the files on make install as well
install(FILES ${CMAKE_SOURCE_DIR}/IsisPreferences DESTINATION ${CMAKE_INSTALL_PREFIX})
install(FILES ${CMAKE_SOURCE_DIR}/BulletEngineSelect.pref DESTINATION ${CMAKE_INSTALL_PREFIX})
install(FILES ${CMAKE_SOURCE_DIR}/../LICENSE.md DESTINATION ${CMAKE_INSTALL_PREFIX})
install(FILES ${CMAKE_SOURCE_DIR}/../AUTHORS.rst DESTINATION ${CMAKE_INSTALL_PREFIX})
install(FILES ${CMAKE_SOURCE_DIR}/../CHANGELOG.md DESTINATION ${CMAKE_INSTALL_PREFIX})
Expand Down
22 changes: 0 additions & 22 deletions isis/IsisPreferences
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,28 +51,6 @@ Group = ErrorFacility
StackTrace = Off
EndGroup

########################################################
# Specify which ray-tracing engine to use for shape
# models.
#
# Leave the ShapeModel Group commented-out to continue
# using the ISIS default.
#
# RayTraceEngine = Bullet | Embree
# OnError = Continue | Fail
# Tolerance = { numerical value that will be set as the
# tolerance for the Bullet or Embree shape
# model }
#
########################################################

#Group = ShapeModel
# RayTraceEngine = Embree
# OnError = Continue
# CubeSupported = False
# Tolerance = DBL_MAX
#EndGroup

########################################################
# Customize how session logging is handled
#
Expand Down
22 changes: 0 additions & 22 deletions isis/TestPreferences
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,28 +49,6 @@ Group = ErrorFacility
StackTrace = Off
EndGroup

########################################################
# Specify which ray-tracing engine to use for shape
# models.
#
# Leave the ShapeModel Group commented-out to continue
# using the ISIS default.
#
# RayTraceEngine = Bullet | Embree
# OnError = Continue | Fail
# Tolerance = { numerical value that will be set as the
# tolerance for the Bullet or Embree shape
# model }
#
########################################################

#Group = ShapeModel
# RayTraceEngine = Embree
# OnError = Continue
# CubeSupported = False
# Tolerance = DBL_MAX
#EndGroup

########################################################
# Customize how session logging is handled
#
Expand Down
8 changes: 5 additions & 3 deletions isis/src/base/apps/spiceinit/spiceinit.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,11 @@
not have their paths expanded. This is to allow variables like $msg/ to work correctly.
</p>
<p>
The spiceinit program will also add the RayTraceEngine, OnError, and Tolerance keywords to the Kernels
group if specified in the IsisPreferences file. If included, these keywords specify the ray-tracing engine to use and how to use it for shapemodels.
Please see the IsisPreferences file for more details.
The <i>spiceinit</i> program will add the RayTraceEngine, OnError, and Tolerance keywords to the Kernels
group if specified in the preference file <i>BulletEngineSelect.pref</i>. These keywords set the
ray-tracing engine to use and how to use it for processing with shapemodels. To include these
keywords, run <i>spiceinit</i> with shape=user, a specified shape model, and
-pref=$ISISROOT/BulletEngineSelect.pref on the command line.

</p>
<p><b>Troubleshooting:</b> If spiceinit is failing with the error
Expand Down