I think the release weekend is a big reason Scott Pilgrim didn't do better. The Expendables and Eat Pray Love are SO polarizing in terms of audience -- the former an absolute must-see for the action nuts, the latter an absolute must-see for the Julia Roberts/rom com brigade -- that there really isn't too much of an audience left over for a nichey comic book adaptation that's heavy on the nerdiness without being all the way anything else. I saw (and paid for) two films this weekend, but most people don't.
I think the marketing has, somewhat, done it a disservice, as well. Yes, it's nerd heaven with comic book and video game aesthetic/references, but ignore those elements and it's really got a fairly universal appeal. I can't think of too many demographic groups that wouldn't find at least something to enjoy here. Unfortunately, the adds don't really convey that.
As for Sucker Punch... been on my radar for a while, not surprisingly, as was Scott Pilgrim, but I doubt that's the case for the non-nerds. No matter the obscurity, though, I think the hot chicks and big action will likely be a large draw once the ads start running. And Zach Snyder is, as of today, a bigger name than Edgar Wright (who still usually needs a "the guy who did..." disclaimer). I predict it will do better than Scott Pilgrim did, depending of course on what shares the opening weekend.