Skip to content

[scautoloc] Add location-dependent depth lookup (Slab2 backend) #126

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
comoglu wants to merge 12 commits into
base: main
Choose a base branch
from
Open

[scautoloc] Add location-dependent depth lookup (Slab2 backend) #126

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
d132182
[scautoloc] Add location-dependent depth lookup
comoglu Jun 4, 2026
58356f7
[scautoloc] Add Slab2 BNA files, dump() and XML descriptions
comoglu Jun 4, 2026
6b9d4e3
[scautoloc] Fix BNA feature name, safe init, consistent path resolution
comoglu Jun 4, 2026
6513111
[scautoloc] Fix Slab2 fetch: treat depth 0 as outside slab zone
comoglu Jun 4, 2026
9f241d4
[scautoloc] Fix namespace comment in depthlookup.cpp
comoglu Jun 4, 2026
f49d5b0
[scautoloc] Fix slabDir default path resolution
comoglu Jun 4, 2026
a0d0879
[scautoloc] Fix BNA install path in CMakeLists
comoglu Jun 4, 2026
bf5ecde
[scautoloc] Fix Slab2 BNA vertex count and polygon lookup
comoglu Jun 4, 2026
dc1a6fe
[scautoloc] Slab2: add debug logging for depth lookup results
comoglu Jun 6, 2026
8292ef4
[scautoloc] Fix local variable naming and typo
comoglu Jul 9, 2026
4c783e7
[scautoloc] Add fetchCandidateDepths for dual-seismicity zones
comoglu Jul 9, 2026
583bf66
[scautoloc] Add Polygon and Composite depth lookup backends
comoglu Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 8 additions & 0 deletions apps/processing/scautoloc/CMakeLists.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ SET(
stationconfig.cpp
stationlocationfile.cpp
picklog.cpp
depthlookup.cpp
)

SET(
Expand All @@ -33,6 +34,7 @@ SET(
stationconfig.h
stationlocationfile.h
picklog.h
depthlookup.h
)

SET(
Expand All @@ -50,5 +52,11 @@ SC_LINK_LIBRARIES_INTERNAL(${LOC_TARGET} client)
SC_INSTALL_DATA(LOC ${LOC_TARGET})
SC_INSTALL_INIT(${LOC_TARGET} ${INIT_TEMPLATE})

# Install Slab2 depth-contour BNA files
INSTALL(
DIRECTORY share/slabs/
DESTINATION share/${LOC_TARGET}/slabs
)

FILE(GLOB descs "${CMAKE_CURRENT_SOURCE_DIR}/descriptions/*.xml")
INSTALL(FILES ${descs} DESTINATION ${SC3_PACKAGE_APP_DESC_DIR})
19 changes: 18 additions & 1 deletion apps/processing/scautoloc/app.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -289,6 +289,23 @@ bool AutolocApp::initConfiguration() {
}
catch ( ... ) {}

try {
_config.depthLookupType = configGetString("autoloc.depthLookup");
}
catch ( ... ) {}

try {
_config.slabDir = Environment::Instance()->absolutePath(configGetString("autoloc.slab2.directory"));
}
catch ( ... ) {
_config.slabDir = Environment::Instance()->shareDir() + "/scautoloc/slabs";
}

try {
_config.polygonRegions = configGetStrings("autoloc.polygon.regions");
}
catch ( ... ) {}

try {
_config.minimumDepth = configGetDouble("locator.minimumDepth");
}
Expand Down Expand Up @@ -819,7 +836,7 @@ void AutolocApp::done() {
ar.setFormattedOutput(_formatted);
ar << _outputEP;
ar.close();
std::cerr << "Output to XML: " << objectCount << " objects(s)" << std::endl;
std::cerr << "Output to XML: " << objectCount << " object(s)" << std::endl;
_outputEP = nullptr;
}

Expand Down
60 changes: 44 additions & 16 deletions apps/processing/scautoloc/autoloc.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
#include "util.h"
#include "scutil.h"
#include "autoloc.h"
#include "depthlookup.h"
#include "stationlocationfile.h"


Expand All @@ -38,6 +39,8 @@ using namespace AutolocInternal;
Autoloc::Autoloc() {
_associator.setOrigins(&_origins);
_relocator.setMinimumDepth(_config.minimumDepth);
// Safe default until init() is called with the actual config
_depthLookup = makeDepthLookup("Constant", _config.defaultDepth, _config.maxDepth);
}
// <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<

Expand Down Expand Up @@ -81,6 +84,15 @@ bool Autoloc::init() {
SEISCOMP_DEBUG("Setting configured locator profile: %s", _config.locatorProfile);
setLocatorProfile(_config.locatorProfile);

_depthLookup = makeDepthLookup(
_config.depthLookupType,
_config.defaultDepth,
_config.maxDepth,
_config.slabDir,
_config.polygonRegions);
SEISCOMP_INFO("DepthLookup: using backend '%s'",
_config.depthLookupType.c_str());

return true; // ready to start processing
}
// <<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<<
Expand Down Expand Up @@ -1320,7 +1332,7 @@ OriginPtr Autoloc::_xxlPreliminaryOrigin(const Pick *newPick)
// loop over several trial depths, which are multiples of the default depth
std::vector<double> trialDepths;
for ( int i = 0; dep <= _config.xxlMaxDepth; i++ ) {
dep = _config.defaultDepth*(1+i);
dep = _depthLookup->fetch(lat, lon)*(1+i);
trialDepths.push_back(dep);

// in case of "sticky" default depth, we don't need any more trial depths
Expand Down Expand Up @@ -1846,17 +1858,31 @@ bool Autoloc::_setDefaultDepth(Origin *origin)
// May be set in an origin far outside the network where depth resolution is expected to be poor,
// or in testing that depth resolution.
{
OriginPtr test = new Origin(*origin);
auto candidates = _depthLookup->fetchCandidateDepths(
origin->hypocenter.lat, origin->hypocenter.lon);

_relocator.setFixedDepth(_config.defaultDepth);
_relocator.useFixedDepth(true);
OriginPtr relo = _relocator.relocate(test.get());
if ( !relo ) {
OriginPtr bestRelo;
double bestScore = -1.0;

for ( double dep : candidates ) {
OriginPtr test = new Origin(*origin);
_relocator.setFixedDepth(dep);
_relocator.useFixedDepth(true);
OriginPtr relo = _relocator.relocate(test.get());
if ( !relo ) continue;
double score = _score(relo.get());
if ( score > bestScore ) {
bestScore = score;
bestRelo = relo;
}
}

if ( !bestRelo ) {
SEISCOMP_WARNING("_setDefaultDepth: failed relocation");
return false;
}

origin->updateFrom(relo.get());
origin->updateFrom(bestRelo.get());
origin->depthType = Origin::DepthDefault;

return true;
Expand Down Expand Up @@ -1889,7 +1915,8 @@ bool Autoloc::_setTheRightDepth(Origin *origin) {
return false;
}

double radius = 5*(relo->hypocenter.dep >= _config.defaultDepth ? relo->hypocenter.dep : _config.defaultDepth)/111.2;
double dd = _depthLookup->fetch(origin->hypocenter.lat, origin->hypocenter.lon);
double radius = 5*(relo->hypocenter.dep >= dd ? relo->hypocenter.dep : dd)/111.2;

// XXX This is a hack, but better than nothing:
// if there are at least 2 stations within 5 times the source depth, we assume sufficient depth resolution.
Expand Down Expand Up @@ -2079,7 +2106,7 @@ bool Autoloc::_rework(Origin *origin) {
}

if ( enforceDefaultDepth ) {
_relocator.setFixedDepth(_config.defaultDepth);
_relocator.setFixedDepth(_depthLookup->fetch(origin->hypocenter.lat, origin->hypocenter.lon));
}

bool keepDepth = adoptManualDepth || enforceDefaultDepth;
Expand Down Expand Up @@ -2128,7 +2155,7 @@ bool Autoloc::_rework(Origin *origin) {
_excludeDistantStations(origin);
_excludePKP(origin);

if ( origin->hypocenter.dep != _config.defaultDepth && origin->depthType == Origin::DepthDefault )
if ( origin->hypocenter.dep != _depthLookup->fetch(origin->hypocenter.lat, origin->hypocenter.lon) && origin->depthType == Origin::DepthDefault )
origin->depthType = Origin::DepthFree;

// once more (see also above)
Expand Down Expand Up @@ -2360,9 +2387,10 @@ bool Autoloc::_publishable(const Origin *origin) const
}


if ( origin->hypocenter.dep > _config.maxDepth ) {
double maxDep = _depthLookup->fetchMaxDepth(origin->hypocenter.lat, origin->hypocenter.lon);
if ( origin->hypocenter.dep > maxDep ) {
SEISCOMP_INFO("Origin %ld too deep: %.1f km > %.1f km (maxDepth)",
origin->id, origin->hypocenter.dep, _config.maxDepth);
origin->id, origin->hypocenter.dep, maxDep);
return false;
}

Expand Down Expand Up @@ -2412,7 +2440,7 @@ bool Autoloc::_store(Origin *origin)
}

if ( origin->depthType == Origin::DepthDefault &&
origin->hypocenter.dep != _config.defaultDepth ) {
origin->hypocenter.dep != _depthLookup->fetch(origin->hypocenter.lat, origin->hypocenter.lon) ) {
origin->depthType = Origin::DepthFree;
}

Expand Down Expand Up @@ -2506,7 +2534,7 @@ bool Autoloc::_associate(Origin *origin, const Pick *pick, const std::string &ph
bool fixed = false;
if ( _config.defaultDepthStickiness > 0.9 ) {
fixed = true;
_relocator.setFixedDepth(_config.defaultDepth);
_relocator.setFixedDepth(_depthLookup->fetch(origin->hypocenter.lat, origin->hypocenter.lon));
}

// else if ( origin->depthType == Origin::DepthManuallyFixed || origin->depthType == Origin::DepthPhases ) {
Expand Down Expand Up @@ -3497,7 +3525,7 @@ bool Autoloc::_depthIsResolvable(Origin *origin) {
// return true;
// }

if ( origin->depthType == Origin::DepthDefault && origin->hypocenter.dep != _config.defaultDepth )
if ( origin->depthType == Origin::DepthDefault && origin->hypocenter.dep != _depthLookup->fetch(origin->hypocenter.lat, origin->hypocenter.lon) )
origin->depthType = Origin::DepthFree;

OriginPtr test = new Origin(*origin);
Expand All @@ -3516,7 +3544,7 @@ bool Autoloc::_depthIsResolvable(Origin *origin) {
}

test = new Origin(*origin);
test->hypocenter.dep = _config.defaultDepth;
test->hypocenter.dep = _depthLookup->fetch(origin->hypocenter.lat, origin->hypocenter.lon);
_relocator.useFixedDepth(true);
relo = _relocator.relocate(test.get());
if ( !relo ) {
Expand Down
2 changes: 2 additions & 0 deletions apps/processing/scautoloc/autoloc.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@
#include "config.h"
#include "stationconfig.h"
#include "picklog.h"
#include "depthlookup.h"


namespace Seiscomp {
Expand Down Expand Up @@ -364,6 +365,7 @@ class Autoloc {
AutolocInternal::OriginVector _origins;
AutolocConfig _config;
AutolocInternal::StationConfig _stationConfig;
DepthLookupPtr _depthLookup;

@jsaul jsaul Jul 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is one DepthLookup. That would mean that scautoloc can use either DepthLookupPolygon or Slab2DepthLookup, right? But what if it needs to use both? The common use case is: Slabs in subduction zones but also regions which only have induced seismicity where I need to fix the depth to a regional default no matter what. Or think of ocean ridges and transform faults, where the value DepthLookupPolygon would be that I can specify explicitly "for this region fix the depth and don't try different depths". Currently there is a default depth but scautoloc always performs some tests to see if an event could be deeper. And occasionally the result is wrong, e.g. if an event at a mid-ocean ridge is located at 120 km depth. DepthLookupPolygon can prevent that very effectively. But ideally not at the expense of Slab2DepthLookup.

@gempa-jabe gempa-jabe Jul 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The idea of the DepthLookup is to outsource that knowledge. If you need a version of DepthLookup with all your special code paths then implement an DepthLookupAutoloc which internally instantiates both classes and does all the processing. scautoloc should just query one interface regardless of the implementation. Think of it as a RecordStream.

@comoglu comoglu Jul 15, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @gempa-jabe
This makes perfect sense, so a DepthLookupComposite (or whatever we call it) in seiscomp/common internally combines Polygon + Slab2 + Constant with priority ordering. scautoloc just queries one interface and doesn't care what's underneath.

That also means Slab2 should move to common, which is what @jsaul was asking for.

One thing I want to flag @jsaul before I start working on it, the original reason I kept it self-contained in scautoloc was @jsaul 's goal of calling autoloc from Python/ObsPy without the full SC environment. Moving to the factory + init(Config::Config&) pattern brings that dependency back in. Is that still a concern, or has that goal changed?

@gempa-jabe gempa-jabe Jul 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't get on it too fast. I am not saying that we need to implement everything in common. I am saying that the strength of the DepthLookup interface is that we are able to remove the complexity of that operation from the client. Having that said, stick to the current implementation in common and add everything needed here to get a proof of concept. I know that an implementation change is just one Claude prompt away but doing that in common is wrong at this stage. The interface is there, two simple example implementations are there and more complex stuff can be added later once proven its usefulness. Please learn your lessons with scautoloc first.

@comoglu comoglu Jul 15, 2026

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Noted, will hold off and will work on proving the concept in scautoloc first. Thanks, @gempa-jabe .

@jsaul jsaul Jul 15, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are several misunderstandings involved and I think we should not discuss everything here on Github (i.e. in public).

Anyway, the Slab2DepthLookup should not be provided through scautoloc. Doesn't have to be in common either, could also be under https://github.com/comoglu - as long as it remains installable. That's the advantage of making it a plugin and not a library function.


const Seiscomp::Config::Config *scconfig {nullptr};
const Seiscomp::DataModel::Inventory *scinventory {nullptr};
Expand Down
11 changes: 10 additions & 1 deletion apps/processing/scautoloc/config.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,16 @@ void AutolocConfig::dump() const {
SEISCOMP_INFO(" maxResidual %.1f s", maxResidualUse);
SEISCOMP_INFO(" maxResidual for keeping picks %.1f s", maxResidualKeep);
SEISCOMP_INFO(" minPhaseCount %d", minPhaseCount);
SEISCOMP_INFO(" maxDepth %.1f km", maxDepth);
SEISCOMP_INFO(" depthLookup %s", depthLookupType.c_str());
if ( depthLookupType == "Slab2" || depthLookupType == "Composite" )
SEISCOMP_INFO(" slab2.directory %s", slabDir.c_str());
if ( depthLookupType == "Polygon" || depthLookupType == "Composite" ) {
std::string regions;
for ( const auto &r : polygonRegions ) regions += (regions.empty() ? "" : ", ") + r;
SEISCOMP_INFO(" polygon.regions %s", regions.c_str());
}
if ( depthLookupType == "Constant" || depthLookupType == "Composite" )
SEISCOMP_INFO(" maxDepth %.1f km", maxDepth);
SEISCOMP_INFO(" minStaCountIgnorePKP %d", minStaCountIgnorePKP);
SEISCOMP_INFO(" defaultDepthStickiness %g", defaultDepthStickiness);
SEISCOMP_INFO(" tryDefaultDepth %s", tryDefaultDepth ? "true" : "false");
Expand Down
20 changes: 18 additions & 2 deletions apps/processing/scautoloc/config.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,21 @@ struct AutolocConfig {
// maxResidualUse = 2*maxRMS


// Use this depth if there is no depth resolution
// DepthLookup backend: "Constant" (default), "Polygon", "Slab2", or "Composite"
std::string depthLookupType{"Constant"};

// Directory containing Slab2 BNA depth-contour files.
// Only used when depthLookupType = "Slab2" or "Composite".
std::string slabDir;

// Named GeoFeature regions for the Polygon backend.
// Each region must carry a defaultDepth attribute in its BNA/GeoJSON.
// Used when depthLookupType = "Polygon" or "Composite".
std::vector<std::string> polygonRegions;

// Use this depth if there is no depth resolution.
// Used directly by the Constant backend; overridden geographically
// by Polygon and Slab2 backends.
double defaultDepth{10.0}; // unit: km
double defaultDepthStickiness{0.5}; // 0...1

Expand All @@ -105,7 +119,9 @@ struct AutolocConfig {
// Minimum depth in case there is depth resolution
double minimumDepth{5.0}; // uni: 5 km

// maximum depth of origin, checked before sending
// maximum depth of origin, checked before sending.
// Used directly by the Constant backend; overridden geographically
// by Polygon and Slab2 backends.
double maxDepth{1000.0};

// Max. secondary azimuthal gap
Expand Down
Loading